Regional Area Object

Regional Area

Description

This Level Object is used to define a Point of Interest area. They can also be used to alter the level lighting or zoom the camera in or out when the Player is inside the area.

Location

Right-click on an empty space in the Layout Scene Manager and choose Logic > Regional Area from the list.

Properties

Name	Type	Description	Read Only
ANGLE
ANGLE	float	The angle if the "Shape" property is set to "Angle".
ANGLE OFFSET	float	The "Angle" minus the specified offset.
BOX SIZE
SIZE	CVector3	The size of the box ( X = width, Y = height, Z = length ) if the "Shape" property is set to "Box".
CAMERA
MULT	float	The camera multiplier when the Player reaches the center of the Regional Area. Note: Only works if "Shape" is "Angle" or "Sphere".
ZOOM SPEED	float	Set the zoom speed between 0.0 - 1.0. 1 will instantly snap to the "Mult" value while 0 will zoom to the "Mult" value based on the center of the Regional Area.
ORIENTATION
FORWARD	CVector3	Forward by X,Y,Z.
RIGHT	CVector3	Right by X,Y,Z.
UP	CVector3	Up by X,Y,Z.
PARTICLE LIGHT
FILE	string	A Particle Light that will fade in and out based on the distance the Player is in the Regional Area.
LIGHT SCALE	float	The scale of the Particle Light.
MAX PERCENT	float	A value from 0.0 - 1.0 that determines when the Particle Light fades in. 1 being the distance to the outside of the Regional Object.
MIN PERCENT	float	A value from 0.0 - 1.0 that determines when the Particle Light is fully on. 1 being the distance to the outside of the Regional Object.
POSITION
POSITION	CVector3	Position by X, Y, Z world coordinates.
PROPERTIES
DIRECTION	string	This does nothing.
ENABLED	bool	Set the Regional Area object enabled or not.
RELEASE ORDER	string	This does nothing.
SHAPE	string	The shape that defines the Regional Area. Angle Box Line Point Sphere
PROPERTY
AUTOMAP ICON	string	Set the mini-map icon for this Regional Area.
QUEST TO USE
QUEST	string	Set a Point of Interest Quest in order to save if the Player has ever discovered this Regional Area or not.
RADIUS
MAX RADIUS	float	Set the maximum radius for the Regional Area.
MIN RADIUS	float	Set the minimum radius for the Regional Area.
USE MAX ONLY	bool	If True only the "Max Radius" will be used.
REGION
AREA NAME	string	The name of the region to display on the UI.
AREA NAME ENTERING	string	The name to display when the Player enters the Regional Area. Leave blank to not display anything.
AREA NAME LEAVING	string	The name to display when the Player exits the Regional Area. Leave blank to not display anything.
DISCOVERED	string	The name of the Regional Area the first time the Player discovers it.
SHAPE VISIBLE
SHAPE VISIBLE	bool	If True the "Shape" of the Regional Area is visible (editor only).

Input Events

Enable

Enable the Regional Area object.

Disable

Disable the Regional Area object.

Output Events

Local Player Entered

This event will be fired when the local Player enters the Regional Area.

Local Player Exited

This event will be fired when the local Player exits the Regional Area.

Enabled

This event will be fired when the Regional Area receives an "Enable" Input event.

Disabled

This event will be fired when the Regional Area receives a "Disable" Input event.