Documentation/Entity Types/Base/Portal.type

From NeoAxis 3D Engine Wiki

Jump to: navigation, search
Go to higher level

Description

Portals are a part of the Portal System and they are put in places, where Zones have apertures. Specific examples of portals are doorways and windows.

Portal 01.jpg

Types of Portals

Portals can be of two types:

  • those connecting two zones,
  • and those connecting a zone with an open space.

The parameter Outdoor is used to determine the type of the areas being connected. If this parameter is set to True the portal is connecting a zone to an open space. If this parameter is set to False the portal is connecting two zones.

If a portal is connecting two zones, its direction (which side is an entrance and which one is an exit) is of no importance.

Portal 02.jpg

If a portal is used to mark an aperture through which an open space may be seen, it should be directed to this open space.

Portal 03.jpg

Properties

Name Description
class Entity
Components List of attached components.
LogicClass Reference to the Logic Editor class. Read more about how to work with the Logic Editor class.
Name Object name.
Tags User defined information. Defined as keyvalue pairs. It is used for user's needs.
Type Object type. It can not be changed.
class MapObject
Position Object position on the map.
Rotation Object rotation. The angle of rotation is set in degrees.
Scale Object scaling.
class Portal
Enabled Enable/disable the portal.
Outdoor If the portal links area with open space. If parameter True is set, it is considered, that the portal links area with open space. If parameter False is set, portal is considered as linking 2 areas.
VisibilityDistance Maximum visible distance of the portal. If the value is 0, then the distance check is not made.
Map Editor
AutoVerticalAlignment Automatical alignment by height mode. Allows to set the value among 4 variants: None (without alignment ), ByBounds (by dimensions), ByBoundsWithRotation (by dimension with possible rotation), ByCenter (by center).
Layer The layer of the map these objects belong to.