[rbdr/sumo] / lib / components / coupled_entities.js

import { Component } from '@serpentity/serpentity';

/**
 * Component that stores a number of entities coupled to this one.
 *
 * @extends {external:Serpentity.Component}
 * @class CoupledEntitiesComponent
 * @param {object} config a configuration object to extend.
 */
export default class CoupledEntitiesComponent extends Component {
  constructor(config) {

    super(config);

    /**
     * An array of coupled entities
     *
     * @property {Array<external:Serpentity.Entity>} coupledEntities
     * @instance
     * @memberof CoupledEntitiesComponent
     */
    this.coupledEntities = this.coupledEntities || [];
  }
}