Function instance

instance(engine: IEngine, compositeData: CompositeResource, compositeProvider: CompositeProvider, options?: InstanceCompositeOptions): Entity
Instance a composite and return its root entity.

Returns
the root entity of the instanced composite
Parameters
- engine: IEngine
  
  the engine that will own the new entities
- compositeData: CompositeResource
  
  the composite resource to instance
- compositeProvider: CompositeProvider
  
  provider used to resolve nested composite references
- Optional options: InstanceCompositeOptions
  
  instancing options (rootEntity, entityMapping, alreadyRequestedSrc)
Returns Entity
- Defined in ecs/dist/composite/index.d.ts:44