Documentation/Entity Types/Base/Region.type

From NeoAxis 3D Engine Wiki

Jump to: navigation, search
Go to higher level

Description

Region.type is used to mark certain areas on the map for further use in multiple ways. The programmer can get the list of objects in the region, as well as receive notifications when objects enter or leave the region.

Region 01.jpg

A usage example of the region type is the map CutSceneDemo. The moment when the character enters this region, a cut scene is played.

CutSceneDemo.map

Properties

Title 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 Region
CheckType The method to determine the contact object in the region. You can choose one of the following values:
  • Bounds — hit is the intersection of the dimensions of the object region,
  • Center — hit is finding the center of the object in the region.
Enabled Enable/disable the region.
Filter Object types entering the region to fix. You can choose one of the following values:
  • All — hit of all objects is fixed,
  • OnlyBodies — hit of the objects that have a physics model is fixed,
  • OnlyDinamicBodies — hit only those objects that have dynamic physical body
ShapeType Shape of the region. You can choose between the following values: Box (box), Sphere (sphere), Capsule (capsule).
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.