Menu
Lumberyard
User Guide (Version 1.13)

Portal

This feature is in preview release and is subject to change.

Use the Portal component to create efficient indoor areas with the VisArea component. Portals are like windows or doors between visible areas. You can use portals to specify areas where you can look out of a visible area and see beyond it.

To use the Portal component, its volume must overlap at least two or more visible areas.

Note

The OccluderArea, Portal, and VisArea components cannot be modified at run time.

Portal Component Properties

The Portal component has the following properties:

Height

Height of the portal.

Valid values: 0100

Default value: 1

DisplayFilled

Display the portal as a filled volume in the Lumberyard Editor viewport.

Default value: False

AffectedBySun

Specify whether the sun affects objects in the portal.

Default value: False

ViewDistRatio

A multiplier on how far the portal is rendered.

Valid values: 0100

Default value: 100

SkyOnly

Only the skybox is rendered outside the portal.

Default value: False

OceanIsVisible

The ocean is rendered outside the portal.

Default value: False

UseDeepness

The portal is treated as an object with a volume instead of a plane.

If false, the portal acts as if it does not have a volume and is treated like a plane between the four floor points.

Default value: True

DoubleSide

Cameras can look through the portal from both sides. If false, the portal only works from one side.

Default value: True

LightBlending

Specify whether to blend light between connected visible areas.

Default value: True

LightBlendValue

The amount of light to blend between connected visible areas.

Valid value: 01

Default value: 0.5

Vertices

The vertices that define the floor of the portal. Portals always have four vertices.

Portal Component Examples

Example 1

In the following examples, two boxes are located inside several visible areas. The visible areas are connected by the portals, which are green. The portal lets you see between the visible areas. The shadows of the boxes inside the visible areas appear because the AffectedBySun option is enabled.


                    Two Portal components connecting multiple
                            VisArea components.

Example 2

In the following example, you can see how the portal lets you see between two visible areas. Although the boxes are in separate visible areas, the portal creates a window between them, so that you can see both boxes.


                    Portal component creates a window between two
                        visible areas.

Example 3

In the following example, you see the portal at an angle. You can't see the box in the other visible area because there is no portal in that line of sight.


                    Portal does not render objects that are not in the line of
                        sight.

Example 4

In the following example, you can see a box through a different portal but the DoubleSide option is disabled; the portal is one-sided only.


                    Portal component with
                            DoubleSide option disabled.

Example 5

In the following example, if you go through the portal and look back, you can see the other visible areas, but you can't see the boxes in those areas. You can't see through portals that are not connected to the visible area that you are in.


                    Visible areas must be connected with a Portal
                        component to let you view between them.