Type Alias IInstantiateOptions

IInstantiateOptions: {
    components?: boolean;
    context?: Context;
    idProvider?: UIDProvider;
    keepWorldPosition?: boolean;
    parent?: string | Object3D;
    position?: Vector3 | [number, number, number];
    rotation?: Quaternion | Euler | [number, number, number];
    scale?: Vector3 | [number, number, number];
    visible?: boolean;
}

Options for instantiating a GameObject, used in instantiate and syncInstantiate

Type declaration

  • Optionalcomponents?: boolean

    If true the components will be cloned as well

    Default

    true
  • Optionalcontext?: Context
  • OptionalidProvider?: UIDProvider

    The ID provider for generating unique IDs / guids

  • OptionalkeepWorldPosition?: boolean

    for duplicatable parenting

  • Optionalparent?: string | Object3D
  • Optionalposition?: Vector3 | [number, number, number]

    position in local space. Set keepWorldPosition to true if this is world space

  • Optionalrotation?: Quaternion | Euler | [number, number, number]

    rotation in local space. Set keepWorldPosition to true if this is world space

  • Optionalscale?: Vector3 | [number, number, number]
  • Optionalvisible?: boolean

    if the instantiated object should be visible

Settings

Member Visibility