func_platrot

func_platrot is a brush entity available in all Source games.

Entity description

It moves vertically, and can rotate while doing so. In code it is represented by class CFuncPlatRot, defined in trains.cpp.

Keyvalues

Movement Sound <sound>

The sound to play when the brush moves.

Stop Sound <sound>

The sound to play when the brush stops moving.

Speed of Rotation <integer>

Speed at which the brush rotates, in degrees per second.

Travel Altitude <integer>

The vertical distance from the starting position that this platform moves. If negative, the platform will lower.

Spin amount <integer>

The amount this platform should rotate as it moves, in degrees.

Minimum Light Level <string>

The minimum level of ambient light that hits this brush.

Targetname:

Name <string>

The targetname that other entities refer to this entity by.

Entity Scripts <scriptlist> (New with Left 4 Dead 2)

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 <string> (New with Left 4 Dead 2)

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.

Parentname:

Parent <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.

Origin:

Origin (X Y Z) <origin>

The position of this entity's center in the world. Rotating entities typically rotate around their origin.

Angles:

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

RenderFields:

Render Mode (rendermode) <choices>

Set a non-standard rendering mode on this entity.

• 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 / Transparency (0 - 255) (renderamt) <integer>

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.

Disable Receiving Shadows (disablereceiveshadows) <boolean>

Prevent the entity from receiving shadows on itself.

RenderFXChoices:

Render FX (renderfx) <choices>

Preset pattern of appearance effects.

• 0: None
• 1: Slow Pulse
• 2: Fast Pulse
• 3: Slow Wide Pulse
• 4: Fast Wide Pulse
• 5: Slow Fade Away
• 6: Fast Fade Away
• 7: Slow Become Solid
• 8: Fast Become Solid
• 9: Slow Strobe
• 10: Fast Strobe
• 11: Faster Strobe
• 12: Slow Flicker
• 13: Fast Flicker
• 14: Constant Glow
• 15: Distort
• 16: Hologram (Distort + fade)
• 17: Scale Up
• 22: Spotlight FX
• 23: Cull By Distance
• 24: Fade Wider Pulse
• 26: Fade Near

To do: 18-21, 25

Shadow:

Disable shadows (disableshadows) <boolean>

Prevent the entity from creating cheap render-to-texture shadows. Does not affect shadow mapping.

Disable ShadowDepth (disableshadowdepth) <boolean> (New with Portal 2)

Used to disable rendering into shadow depth (for projected textures) for this entity.

Projected Texture Cache (shadowdepthnocache) <choices> (New with Portal 2)

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> (New with Portal 2)

Used to disable projected texture lighting and shadows on this entity.

Flags

• 1 : Toggle
• 64 : X Axis
• 128 : Y Axis

Inputs

Targetname:

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 than Kill.

AddOutput  <string>

Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.
Format: <key> <value>
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. Can also be invoked by creating an output that does not specify an input.
This input is not included in Valve's FGDs.

RunScriptFile  <script> (New with Left 4 Dead 2)

Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.

RunScriptCode  <string> (New with Left 4 Dead 2)

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> (New with Left 4 Dead 2) !FGD

Execute a VScript function in the scope of the receiving entity.

SetLocalOrigin  <coordinates> (New with Alien Swarm) !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> (New with Alien Swarm) !FGD

Set this entity's angles.

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.

RenderFields:

Alpha  <integer>

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.

Color  <color255>

Sets an RGB color for the entity.

BasePlat:

Toggle

Toggles the platform's state.

GoUp

Tells the platform to go up.

GoDown

Tells the platform to go down.

Shadow:

DisableShadow

Turn shadow off.

EnableShadow

Turn shadow on.

DisableReceivingFlashlight  (New with Portal 2)

This object will not receive light or shadows from projected textures.

EnableReceivingFlashlight  (New with Portal 2)

This object may receive light or shadows from projected textures.

Outputs

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 the Left 4 Dead series)

This Output fires when the entity is killed and removed from the game.