Documentation/Entity Types/Base/GeneralMapObject.type

From NeoAxis 3D Engine Wiki

Jump to: navigation, search
Go to higher level

Description

GeneralMapObject is intended to quickly create objects in the Map Editor. This type doesn't have any special functionality or properties. It is assumed that a user builds every object of parts by attaching various components to it. As opposed to creating map objects, there's an option to create and configure object types with further placement of those objects in the Map Editor.

GeneralMapObject 01.jpg

Components attached to the object are:

Attaching components to objects is basic capability of all objects. Therefore, a user can extend any type. The feature of GeneralMapObject is it doesn't have any components attached to it, and every object of this type is configured from scratch.

For multiple use of GeneralMapObject with similar elements creating of an object type is preferred. You can learn more about this in the creating a simple object type tutorial.

Creation

Let's see how to create a GeneralMapObject object using the example of a burning barrel. The barell is a static mesh and the fire is a particle system.

Place the object on the map. You can find this type in the (Object Creation) window, in the Base\Types\Basic folder.

GeneralMapObject 02.jpg

Initially, GeneralMapObject is an empty object functioning as a container to other objects. Let's fill it.

Select the just created object. In the properties window click the "..." button next to the Components properties.

GeneralMapObject 03.jpg

In the opened window, in the dropdown list of the Add button select the type of an object we want to add — MapObjectComponent_Mesh.

GeneralMapObject 04.jpg

Specify the path to the 3D model in the Mesh Name box of the Mesh property group. In our example we select a 3D model of a barrel from the Village Demo map located in the Data\Maps\VillageDemo\FarmModels\Meshes folder.

GeneralMapObject 05.jpg

Now, we add flames to our object. In the dropdown of the Add button select MapObjectComponent_Particle. Several particle system variants to simulate fire are already included in the SDK. In the Particle property group, put the BigFireParticle particle system from the Data\Effects\FireParticle folder to the Particle System Name field. Also, raise the flame over the barrel by setting the Position Offset parameter in the _General property group to "0 0 1".

GeneralMapObject 06.jpg

In the Component Collection Editor click OK. We have finished creating a burning barrel.

GeneralMapObject 07.jpg

A 3D model and a particle system are just two of object types you can attach to GeneralMapObject. You could as easy add to this burning barrel the sound of fire or a light source to simulate lighting of surroundings around the fire.

Properties

GeneralMapObject is an empty dummy object and it does not have any special properties.

Properties of components that are part of the SDK is thoroughly described in the object components overview.

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.
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.