Documentation/Entity Types/Special/Freeze Objects Manager.type

From NeoAxis 3D Engine Wiki

Jump to: navigation, search
Go to higher level

Description

Freeze Objects Manager is a special object that allows you to manage off objects on the map, in order to improve the speed of the maps with big amount of the objects.

When you enable this property, all objects are frozen (not updated). There are three ways to enable objects:

  • 1. Depending on the distance of the object from the camera.
  • 2. By means unfreezing areas.
  • 3. From the code by means property MapObject._FreezeObjectsManagerNeverFreeze.

The "Data\Maps\Samples\Freeze Objects Manager\Map.map" map is a perfect example.

FreezeObjectsManager01.jpg

Properties

Special properties Freeze Objects Manager are in the group FreezeObjectsManager.

Parameter 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.
Freeze Objects Manager
Cell Count The amount of cells of the 3D grid. The grid is used for fast search areas by the position.
Cell Min Size Minimal cell size of the 3D grid. The grid is used for fast search areas by the position.
Debug Draw Grid Enables drawing the structure of the 3D grid. The grid is used for fast search areas by the position.
Enabled A value indicating whether the manager enabled.
Enabled In Editor A value indicating whether the manager enabled in Map Editor.
Unfreeze By Camera Distance Specifies the value for unfreezing by camera distance.
Unfreeze By Camera Z Distance Defines to shape for unfreezing by camera distance. Set "0" for sphere shape, else special Z distance is enabled (cylinder shape).