Func plat

From Valve Developer Community

Table of contents

1 Entity Description 1.1 FGD Code 2 Keyvalues 3 Flags 4 Inputs 5 Outputs

Entity Description

FGD Code

@SolidClass base(BasePlat) = func_plat :
	"A brush entity that moves vertically, and can rotate while doing so."
[
	spawnflags(flags) =
	[
		1: "Toggle" : 1
	]
	noise1(sound) : "Movement Sound" : : "The sound to play when the brush moves."
	noise2(sound) : "Stop Sound" : : "The sound to play when the brush stops moving."
	speed(float) : "Speed" : "50.000000" : "Speed at which the brush moves"
	lip(float) : "Lip" : "0.000000" :	"The amount, in inches, of the button to leave " +
						"sticking out of the wall it recedes into when " +
						"pressed. Negative values make the button recede " +
						"even further into the wall."
]

Keyvalues

• targetname <target_source>

Defines the name that other entities refer to this entity by.

• hammerid [Episode Two Update]

<integer readonly> This id is used for debugging purposes in Hammer.

• parentname <target_destination>

Specifies the targetname of this entity's Parent in a movement hierarchy. Child entities move with their Parent.

• origin

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

• angles <angle>

Pitch Yaw Roll (Y Z X)

This entity's angular orientation in the world (also used for angular effect entities).

• renderfx

<choices>

Literal Value	Description
0	Normal
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 (TEST)
24	Fade Wider Pulse

• rendermode

<choices> Used to set a non-standard rendering mode on this entity. See also 'FX Amount' and 'FX Color'.

Literal Value	Render Mode	Description (Click for more info.)
0	Normal	Default rendering.
1	Color	Obsolete.
2	Texture	Plain opacity.
3	Glow	No Z buffer checks. Fixed size on screen.
4	Solid / Alphatest	Obsolete. (Use alphatest capabilities in materials instead.)
5	Additive	Obsolete. Add this entity's color to what's behind it.
7	Additive Fractional Frame	Obsolete? Blend between animation frames.
8	Alpha Add (Not in FGD.)	Add alpha.
9	World Space Glow	No Z buffer checks. Fixed size in world (as opposed to on screen).
10	Dont Render / None	Don't render.

• renderamt

<integer> FX Amount (0 - 255) - How opaque the entity will be rendered. (0 is fully transparent, while 255 is fully opaque). Will not work if the rendermode keyvalue is set to Normal or Dont Render.

• rendercolor

<color255> FX Color - What color the entity will be rendered in (to the degree of the opacity set with renderamt).

• disableshadows

<boolean> Used to disable dynamic shadow casting from this entity.

• noise1

<sound> The sound to play when the brush moves.

• noise2

<sound> The sound to play when the brush stops moving.

• speed

<integer> Speed at which the brush moves.

• lip

<float> The amount, in inches, of the button to leave sticking out of the wall it recedes into when pressed. Negative values make the button recede even further into the wall."

Flags

• 1 : Toggle

Inputs

• Kill

Removes this entity from the world.

• KillHierarchy

Removes this entity and all its children from the world.

• 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 == infinite)>

• FireUser1-4

Causes this entity's OnUser1-4 outputs to be fired. See User Inputs and Outputs.

• SetParent <target_destination>

Changes the entity's parent in the movement hierarchy.

• SetParentAttachment <string>

Change this entity to attach to a specific attachment point on its parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment.

• SetParentAttachmentMaintainOffset <string> [Episode One Update]

Change this entity to attach to a specific attachment point on it's parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment. The entity will maintain it's position relative to the Parent's Origin and Angles at the time it is attached.

• ClearParent

Removes this entity from its current movement hierarchy.

• Toggle

Toggles the platform's state.

• GoUp

Tells the platform to go up.

• GoDown

Tells the platform to go down.

• DisableShadow

Turn shadow off.

• EnableShadow

Turn shadow on.

Outputs

• OnUser1-4

Fired in response to FireUser1-4 inputs. See User Inputs and Outputs.

!activator = activator