PlanarReflectorGeComponentDef

PBE 16.22 changes this class. This page shows the live definition. PBE changes

Inheritance 1 ancestor · 40 siblings

IGeComponentDef

Class Documentation

The definition of a PlanarReflectorGeComponent: a planar reflection placed as an entity, on a PlanarReflectorEntityTemplate. The client renders the scene mirrored in a plane into a reflection texture.

The plane. The mirror plane passes through the entity's position, and its normal is the entity's Y axis. Polygon is used only to decide whether the reflector is in view.

Selection. While the entity is active, its reflector is in the client's reflector list. Each frame the client takes the first reflector in the list whose transformed Polygon intersects the view frustum. If no entity reflector is in view, the client falls back to the planar reflectors of the map's .mapgeo.

The reflection setting. A graphics setting controls the reflection pass:

Setting	Pass
`0`	off
`1`	runs only when the selected reflector has `ForceOn`
`2` or higher	runs every frame with the default render options

The five render options of this class (RenderSunShadow, RenderEnvironment, RenderParticles, SSAO, DynamicLighting) apply only in the ForceOn case at setting 1. At setting 2 or higher the pass uses its defaults: no sun shadow, environment on, particles on, no SSAO, no dynamic lighting, whatever the definition says.

Changes on PBE 16.22

RenderParticles removed Bool

Properties

DynamicLighting

Bool = false

16.9

Documentation Edit documentation

Applies dynamic lighting in the reflection pass. It applies only with ForceOn.

ForceOn

Bool = false

16.10

Documentation Edit documentation

Runs the reflection pass for this reflector when the reflection setting is 1, and makes the pass use the five render options of this definition.

PercentageResolution

U8 = 100

16.9

Documentation Edit documentation

Size of the reflection texture, in percent of the viewport. It applies in the client's default reflection resolution mode.

Polygon

Embed<EntityPolygonData>

Default value

{
  "Smooth": false,
  "Vertices": [
    [-200, 0, -200],
    [200, 0, -200],
    [200, 0, 200],
    [-200, 0, 200]
  ]
}

Documentation Edit documentation

Outline of the reflector, an EntityPolygonData in the entity's local space. After the entity's transform, the client tests it against the view frustum to select the reflector.