Model: Entity Type

An entity type defines the characteristics that are common to all entity instances. In particular, an entity type defines which components it is combined from. Additional properties can also be defined.

Data Model

FieldDataTypeDescriptionExample
NamespaceStringThe namespacecore
NameStringThe name of the entity typeplayer
DescriptionStringTextual description of the entity type
ComponentsVec<Component>The components which composes the entity type. These provides additional properties
PropertiesVec<Property Type>The additional properties on entity instances
ExtensionsVec<Extension>A list of extensions which contains additional information

ER Diagram

erDiagram
    Entity-Type {
        string namespace
        string name
    }
    Entity-Instance {
        string id
        string label
    }
    Extension {
        string namespace
        string name
        JSON extension
    }
    Component {
        string namespace
        string name
    }
    Property-Type {
        string name
        enum DataType
        enum SocketType
        enum Mutability
    }
    Relation-Type {
        string namespace
        string name
    }
    Entity-Type ||--}o Property-Type : defines
    Relation-Type ||--}o Property-Type : defines
    Component ||--}o Property-Type : defines
    Entity-Type ||--}o Relation-Type : outbound
    Entity-Type ||--}o Relation-Type : inbound
    Relation-Type o{--}o Component : composes
    Entity-Type ||--}o Extension : has
    Relation-Type ||--}o Extension : has
    Property-Type ||--}o Extension : has
    Entity-Instance ||--}o Entity-Type : is-a
    Entity-Type o{--}o Component : composes

GraphQL

JSON Schema

JSON Schema

http://hostname:port/types/entities/schema