Page tree

This page has not yet been translated to English.

Skip to end of metadata
Go to start of metadata

Entity describes document structure and behavior.

It has to have a unique name and a set of attributes describing the document elements.

Entity parameters

Name

Description

Example

Name

Technical name which is used to refer to the entity by the system and becomes class name when source code is generated. Also used as a document collection name when saving to file. Use of singular nouns is recommended.

CraftingBlueprint

Display Name

Text which is displayed in the editor UI as a name for the entity or the entity's document collection.

Item Blueprint

Description

Text which is displayed in the editor UI and becomes a comment when source code is generated.

This is a blueprint of an item.

Group

Name of a group of entities. You can assign entities into groups for better visual sorting in the editor.

Crafting

Id Generator

Type of an ID Generator for this entity's documents. User has to manually enter document ID if this value is unassigned.


Specifications

Additional parameters which are accessed during source code generation or via the editor.

Format: HTTP Query String.


Attributes

A list of the attributes belonging to the entity and used to describe the entity's document structure.


Naming restrictions

Name can contain only alphanumeric characters and 'underscore' symbol (though it cannot begin with a number or an underscore).

The following names are reserved and cannot be used:

  • Collections
  • Id
  • Entity
  • Attribute
  • ProjectSettings

Entity types

While describing an entity, you can specify its type:

  • Settings - The entity is a setting or a parameter, and only one instance of it will ever exist. This will affect how it is treated by the data editor and source code generator.
  • Component - This entity is a component of a parent entity and will always belong to it. Such entities will not be displayed in the entity list (left side) in the data editor.

Related pages