This article's documentation is for anything that uses the Source engine. Click here for more information.

Func platrot: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Add internal names of keyval keys)
mNo edit summary
 
(9 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{base_brush|func_platrot}}  
__NOTOC__
{{subpage|[[Trains]]}}
{{TabsBar|main=gs|base=func_platrot}}
{{CD|CFuncPlatRot|file1=trains.cpp}}
{{this is a|brush entity|name=func_platrot}} It moves vertically, and can rotate while doing so.


==Entity description==
== KeyValues ==
It moves vertically, and can rotate while doing so.
{{KV Targetname}}
In code it is represented by class CFuncPlatRot, defined in trains.cpp.
 
== Keyvalues ==
{{KV|Movement Sound|intn=noise1|sound|The sound to play when the brush moves.}}
{{KV|Movement Sound|intn=noise1|sound|The sound to play when the brush moves.}}
{{KV|Stop Sound|intn=noise2|sound|The sound to play when the brush stops moving.}}
{{KV|Stop Sound|intn=noise2|sound|The sound to play when the brush stops moving.}}
Line 11: Line 12:
{{KV|Travel Altitude|intn=height|integer|The vertical distance from the starting position that this platform moves. If negative, the platform will lower.}}
{{KV|Travel Altitude|intn=height|integer|The vertical distance from the starting position that this platform moves. If negative, the platform will lower.}}
{{KV|Spin amount|intn=rotation|integer|The amount this platform should rotate as it moves, in degrees.}}
{{KV|Spin amount|intn=rotation|integer|The amount this platform should rotate as it moves, in degrees.}}
{{KV|Minimum Light Level|intn=_minlight|string|The minimum level of ambient light that hits this brush.}}
{{KV Targetname}}
{{KV Parentname}}
{{KV Origin}}
{{KV Angles}}
{{KV RenderFields}}
{{KV Shadow}}


== Flags ==
== Flags ==
* 1 : Toggle
{{fl|1|Toggle}}
* 64 : X Axis
{{fl|64|X Axis}}
* 128 : Y Axis
{{fl|128|Y Axis}}


== Inputs ==
== Inputs ==
{{I Targetname}}
{{I Parentname}}
{{I RenderFields}}
{{I BasePlat}}
{{I BasePlat}}
{{I Shadow}}


== Outputs ==
== See also ==
{{O Targetname}}
* {{ent|func_plat}}

Latest revision as of 19:06, 14 April 2025

C++ Class hierarchy
CFuncPlatRot
CFuncPlat
CBasePlatTrain
CBaseToggle
CBaseEntity
C++ trains.cpp

func_platrot is a brush entity available in all Source Source games. It moves vertically, and can rotate while doing so.

KeyValues

Name (targetname) <string>[ Edit ]
The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also:  Generic Keyvalues, Inputs and Outputs available to all entities

Movement Sound (noise1) <sound>
The sound to play when the brush moves.
Stop Sound (noise2) <sound>
The sound to play when the brush stops moving.
Speed of Rotation (speed) <integer>
Speed at which the brush rotates, in degrees per second.
Travel Altitude (height) <integer>
The vertical distance from the starting position that this platform moves. If negative, the platform will lower.
Spin amount (rotation) <integer>
The amount this platform should rotate as it moves, in degrees.

Flags

Toggle : [1]
X Axis : [64]
Y Axis : [128]

Inputs

BasePlat:
Toggle
Toggles the platform's state.
GoUp
Tells the platform to go up.
GoDown
Tells the platform to go down.

See also