Class GameObjectAbstract

constructor

• new GameObject(): GameObject

• This creates a new Object3D object.

  Returns GameObject

AbstractactiveSelf

AbstractworldForward

• get worldForward(): Vector3

• Get the world forward vector of the Object3D.
  Added by Needle Engine.

  Returns Vector3

AbstractworldPosition

• get worldPosition(): Vector3

• Get or set the world position of the Object3D.
  Added by Needle Engine.

  Returns Vector3
• set worldPosition(val): void

• Get or set the world position of the Object3D.
  Added by Needle Engine.

  Parameters

  • val: Vector3

  Returns void

AbstractworldQuaternion

• get worldQuaternion(): Quaternion

• Get or set the world quaternion of the Object3D.
  Added by Needle Engine.

  Returns Quaternion
• set worldQuaternion(val): void

• Get or set the world quaternion of the Object3D.
  Added by Needle Engine.

  Parameters

  • val: Quaternion

  Returns void

AbstractworldRight

• get worldRight(): Vector3

• Get the world right vector of the Object3D.
  Added by Needle Engine.

  Returns Vector3

AbstractworldRotation

• get worldRotation(): Vector3

• Get or set the world rotation of the Object3D.
  Added by Needle Engine.

  Returns Vector3
• set worldRotation(val): void

• Get or set the world rotation of the Object3D.
  Added by Needle Engine.

  Parameters

  • val: Vector3

  Returns void

AbstractworldScale

• get worldScale(): Vector3

• Get or set the world scale of the Object3D.
  Added by Needle Engine.

  Returns Vector3
• set worldScale(val): void

• Get or set the world scale of the Object3D.
  Added by Needle Engine.

  Parameters

  • val: Vector3

  Returns void

AbstractworldUp

• get worldUp(): Vector3

• Get the world up vector of the Object3D.
  Added by Needle Engine.

  Returns Vector3

AbstractaddComponent

• addComponent<T>(comp, init?): T

• creates a new component on this gameObject

  Type Parameters

  • T extends IComponent

  Parameters

  • comp: T | ConstructorConcrete<T>
  • Optionalinit: Partial<NoInternalNeedleEngineState<FilterStartingWith<FilterTypes<T, undefined | null | Function>, "_">>>

  Returns T

Abstractdestroy

• destroy(): any

• Destroys the Object3D and all its Needle Engine components.

  Returns any

AbstractgetComponent

• getComponent<T>(type): null | T

• Get a Needle Engine component from the Object3D.

  Type Parameters

  • T

  Parameters

  • type: Constructor<T>

  Returns null | T

  The component instance or null if not found.

AbstractgetComponentInChildren

• getComponentInChildren<T>(type): null | T

• Get a Needle Engine component from the Object3D or its children. This will search on the current Object and all its children.

  Type Parameters

  • T

  Parameters

  • type: Constructor<T>

  Returns null | T

  The component instance or null if not found.

AbstractgetComponentInParent

• getComponentInParent<T>(type): null | T

• Get a Needle Engine component from the Object3D or its parents. This will search on the current Object and all its parents.

  Type Parameters

  • T

  Parameters

  • type: Constructor<T>

  Returns null | T

  The component instance or null if not found.

AbstractgetComponents

• getComponents<T>(type, arr?): T[]

• Get all components of a specific type from the Object3D.

  Type Parameters

  • T

  Parameters

  • type: Constructor<T>
  • Optionalarr: T[]

    Optional array to fill with the found components.

  Returns T[]

  An array of components.

AbstractgetComponentsInChildren

• getComponentsInChildren<T>(type, arr?): T[]

• Get all components of a specific type from the Object3D or its children. This will search on the current Object and all its children.

  Type Parameters

  • T

  Parameters

  • type: Constructor<T>
  • Optionalarr: T[]

    Optional array to fill with the found components.

  Returns T[]

  An array of components.

AbstractgetComponentsInParent

• getComponentsInParent<T>(type, arr?): T[]

• Get all Needle Engine components of a specific type from the Object3D or its parents. This will search on the current Object and all its parents.

  Type Parameters

  • T

  Parameters

  • type: Constructor<T>
  • Optionalarr: T[]

    Optional array to fill with the found components.

  Returns T[]

  An array of components.

AbstractgetOrAddComponent

• getOrAddComponent<T>(typeName): T

• Get or add a Needle Engine component to the Object3D. If the component already exists, it will be returned. Otherwise, a new component will be added.

  Type Parameters

  • T

  Parameters

  • typeName: null | ConstructorConcrete<T>

    The component constructor to get or add.

  Returns T

  The component instance.

AbstractremoveComponent

• removeComponent<T>(comp): T

• Remove a Needle Engine component from the Object3D.

  Type Parameters

  • T extends IComponent

  Parameters

  • comp: T

  Returns T

Staticadd

• add(instance, parent, context?): void

• Add an object to parent and also ensure all components are being registered

  Parameters

  • instance: undefined | null | Object3D<Object3DEventMap>
  • parent: Object3D<Object3DEventMap>
  • Optionalcontext: Context

  Returns void

StaticaddComponent

• addComponent<T>(go, instanceOrType, init?, opts?): T

• Add a new component (or move an existing component) to the provided object

  Type Parameters

  • T extends IComponent

  Parameters

  • go: Object3D<Object3DEventMap> | IGameObject

    object to add the component to
  • instanceOrType: T | ConstructorConcrete<T>

    if an instance is provided it will be moved to the new object, if a type is provided a new instance will be created and moved to the new object
  • Optionalinit: Partial<NoInternalNeedleEngineState<FilterStartingWith<FilterTypes<T, undefined | null | Function>, "_">>>

    optional init object to initialize the component with
  • Optionalopts: {
        callAwake: boolean;
    }

    • callAwake: boolean

  Returns T

Staticdestroy

• destroy(instance, recursive?): void

• Destroys a object

  Parameters

  • instance: Object3D<Object3DEventMap> | Behaviour

    object to destroy
  • recursive: boolean = true

    if true, all children will be destroyed as well. true by default

  Returns void

StaticdestroySynced

• destroySynced(instance, context?, recursive?): void

• Destroys a object on all connected clients (if you are in a networked session)

  Parameters

  • instance: Object3D<Object3DEventMap> | Behaviour

    object to destroy
  • Optionalcontext: Context
  • recursive: boolean = true

  Returns void

StaticfindByGuid

• findByGuid(guid, hierarchy):
      | undefined
      | null
      | Behaviour
      | GameObject

• Parameters

  • guid: string
  • hierarchy: Object3D<Object3DEventMap>

  Returns
      | undefined
      | null
      | Behaviour
      | GameObject

StaticfindObjectOfType

• findObjectOfType<T>(typeName, context?, includeInactive?): null | T

• Type Parameters

  • T extends IComponent

  Parameters

  • typeName: Constructor<T>
  • Optionalcontext: Object3D<Object3DEventMap> | Context
  • includeInactive: boolean = true

  Returns null | T

StaticfindObjectsOfType

• findObjectsOfType<T>(typeName, context?): T[]

• Type Parameters

  • T extends IComponent

  Parameters

  • typeName: Constructor<T>
  • Optionalcontext: Object3D<Object3DEventMap> | Context

  Returns T[]

StaticforeachComponent

• foreachComponent(instance, cb, recursive?): any

• Run a callback for all components of the provided type on the provided object and its children (if recursive is true)

  Parameters

  • instance: Object3D<Object3DEventMap>

    object to run the method on
  • cb: ((comp: Behaviour) => any)

    callback to run on each component, "return undefined;" to continue and "return ;" to break the loop

    • • (comp): any

      • Parameters

        • comp: Behaviour

        Returns any

  • recursive: boolean = true

    if true, the method will be run on all children as well

  Returns any

  the last return value of the callback

StaticgetAllComponents

• getAllComponents(go): Behaviour[]

• Parameters

  • go: Object3D<Object3DEventMap> | IGameObject

  Returns Behaviour[]

StaticgetComponent

• getComponent<T>(go, typeName): null | T

• Gets a component on the provided object

  Type Parameters

  • T extends IComponent

  Parameters

  • go: null | Object3D<Object3DEventMap> | IGameObject
  • typeName: null | Constructor<T>

  Returns null | T

StaticgetComponentInChildren

• getComponentInChildren<T>(go, typeName): null | T

• Type Parameters

  • T extends IComponent

  Parameters

  • go: Object3D<Object3DEventMap> | IGameObject
  • typeName: Constructor<T>

  Returns null | T

StaticgetComponentInParent

• getComponentInParent<T>(go, typeName): null | T

• Type Parameters

  • T extends IComponent

  Parameters

  • go: Object3D<Object3DEventMap> | IGameObject
  • typeName: Constructor<T>

  Returns null | T

StaticgetComponents

• getComponents<T>(go, typeName, arr?): T[]

• Type Parameters

  • T extends IComponent

  Parameters

  • go: null | Object3D<Object3DEventMap> | IGameObject
  • typeName: Constructor<T>
  • arr: null | T[] = null

  Returns T[]

StaticgetComponentsInChildren

• getComponentsInChildren<T>(go, typeName, arr?): T[]

• Type Parameters

  • T extends IComponent

  Parameters

  • go: Object3D<Object3DEventMap> | IGameObject
  • typeName: Constructor<T>
  • arr: null | T[] = null

  Returns T[]

StaticgetComponentsInParent

• getComponentsInParent<T>(go, typeName, arr?): T[]

• Type Parameters

  • T extends IComponent

  Parameters

  • go: Object3D<Object3DEventMap> | IGameObject
  • typeName: Constructor<T>
  • arr: null | T[] = null

  Returns T[]

StaticgetOrAddComponent

• getOrAddComponent<T>(go, typeName): T

• Type Parameters

  • T extends IComponent

  Parameters

  • go: Object3D<Object3DEventMap> | IGameObject
  • typeName: ConstructorConcrete<T>

  Returns T

Staticinstantiate

• instantiate(instance, opts?): GameObject

• Creates a new instance of the provided object (like cloning it including all components and children)

  Parameters

  • instance: Object3D<Object3DEventMap> | GameObject

    object to instantiate
  • opts: null | IInstantiateOptions = null

    options for the instantiation (e.g. with what parent, position, etc.)

  Returns GameObject

StaticinstantiateSynced

• instantiateSynced(instance, opts): null | GameObject

• Creates a new instance of the provided object. The new instance will be created on all connected clients

  Parameters

  • instance: null | Object3D<Object3DEventMap> | GameObject

    object to instantiate
  • opts: SyncInstantiateOptions

    options for the instantiation

  Returns null | GameObject

Staticinvoke

• invoke(go, functionName, children?, ...args): void

• Invokes a method on all components that have a method matching the provided name

  Parameters

  • go: undefined | null | Object3D<Object3DEventMap>

    object to invoke the method on all components
  • functionName: string

    name of the method to invoke
  • children: boolean = false
  • Rest...args: any

  Returns void

StaticinvokeOnChildren

• invokeOnChildren(go, functionName, ...args): void

• Invokes a method on all components including children (if a method with that name exists)

  Parameters

  • go: undefined | null | Object3D<Object3DEventMap>
  • functionName: string
  • Rest...args: any

  Returns void

StaticisActiveInHierarchy

• isActiveInHierarchy(go): boolean

• If the object is active in the hierarchy (e.g. if any parent is invisible or not in the scene it will be false)

  Parameters

  • go: Object3D<Object3DEventMap>

    object to check

  Returns boolean

StaticisActiveSelf

• isActiveSelf(go): boolean

• If the object is active (same as go.visible)

  Parameters

  • go: Object3D<Object3DEventMap>

  Returns boolean

StaticisDestroyed

• isDestroyed(go): boolean

• Parameters

  • go: Object3D<Object3DEventMap>

  Returns boolean

StaticisUsingInstancing

• isUsingInstancing(instance): boolean

• Parameters

  • instance: Object3D<Object3DEventMap>

  Returns boolean

StaticiterateComponents

• iterateComponents(go): Generator<any, void, unknown>

• Parameters

  • go: Object3D<Object3DEventMap> | IGameObject

  Returns Generator<any, void, unknown>

StaticmarkAsInstancedRendered

• markAsInstancedRendered(go, instanced): void

• Parameters

  • go: Object3D<Object3DEventMap>
  • instanced: boolean

  Returns void

StaticmoveComponent

• moveComponent<T>(go, instance): T

• Moves a component to a new object

  Type Parameters

  • T extends IComponent

  Parameters

  • go: Object3D<Object3DEventMap> | IGameObject

    component to move the component to
  • instance: T | ConstructorConcrete<T>

    component to move to the GO

  Returns T

Staticremove

• remove(instance): void

• Removes the object from its parent and deactivates all of its components

  Parameters

  • instance: undefined | null | Object3D<Object3DEventMap>

  Returns void

StaticremoveComponent

• removeComponent<T>(instance): T

• Removes a component from its object

  Type Parameters

  • T extends IComponent

  Parameters

  • instance: T

    component to remove

  Returns T

StaticsetActive

• setActive(go, active, processStart?): void

• Parameters

  • go: Object3D<Object3DEventMap>
  • active: boolean
  • processStart: boolean = true

  Returns void