Class GameObjectAbstract

All {@type Object3D} types that are loaded in Needle Engine do automatically receive the GameObject extensions like addComponent etc.
Many of the GameObject methods can be imported directly via @needle-tools/engine as well:

import { addComponent } from "@needle-tools/engine";

Hierarchy

Implements

Constructors

constructor

Accessors

transform worldForward worldPosition worldQuaternion worldRight worldRotation worldScale worldUp

Methods

addComponent addNewComponent destroy getComponent getComponentInChildren getComponentInParent getComponents getComponentsInChildren getComponentsInParent getOrAddComponent removeComponent add addComponent addNewComponent destroy destroySynced findByGuid findObjectOfType findObjectsOfType foreachComponent getAllComponents getComponent getComponentInChildren getComponentInParent getComponents getComponentsInChildren getComponentsInParent getOrAddComponent instantiate instantiateSynced invoke invokeOnChildren isActiveInHierarchy isActiveSelf isDestroyed isUsingInstancing iterateComponents markAsInstancedRendered moveComponent remove removeComponent setActive

Constructors

constructor

Accessors

Abstract transform

Abstract worldForward

  • get worldForward(): Vector3

  • Returns Vector3

Abstract worldPosition

  • get worldPosition(): Vector3

  • Returns Vector3

  • set worldPosition(val): void

  • Parameters

    Returns void

Abstract worldQuaternion

  • get worldQuaternion(): Quaternion

  • Returns Quaternion

  • set worldQuaternion(val): void

  • Parameters

    Returns void

Abstract worldRight

  • get worldRight(): Vector3

  • Returns Vector3

Abstract worldRotation

  • get worldRotation(): Vector3

  • Returns Vector3

  • set worldRotation(val): void

  • Parameters

    Returns void

Abstract worldScale

  • get worldScale(): Vector3

  • Returns Vector3

  • set worldScale(val): void

  • Parameters

    Returns void

Abstract worldUp

  • get worldUp(): Vector3

  • Returns Vector3

Methods

Abstract addComponent

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

  • creates a new component on this gameObject

    Type Parameters

    • T extends IComponent

    Parameters

    • comp: T | ConstructorConcrete<T>
    • Optional init: Partial<NoInternalNeedleEngineState<FilterStartingWith<FilterTypes<T, Function>, "_">>>

    Returns T

Abstract addNewComponent

  • addNewComponent<T>(type, init?): T

  • Type Parameters

    • T extends IComponent

    Parameters

    • type: ConstructorConcrete<T>
    • Optional init: Partial<NoInternalNeedleEngineState<FilterStartingWith<FilterTypes<T, Function>, "_">>>

    Returns T

    Deprecated

    use addComponent

Abstract destroy

  • destroy(): any

  • Returns any

Abstract getComponent

  • getComponent<T>(type): T

  • Type Parameters

    • T

    Parameters

    • type: Constructor<T>

    Returns T

Abstract getComponentInChildren

  • getComponentInChildren<T>(type): T

  • Type Parameters

    • T

    Parameters

    • type: Constructor<T>

    Returns T

Abstract getComponentInParent

  • getComponentInParent<T>(type): T

  • Type Parameters

    • T

    Parameters

    • type: Constructor<T>

    Returns T

Abstract getComponents

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

  • Type Parameters

    • T

    Parameters

    • type: Constructor<T>
    • Optional arr: T[]

    Returns T[]

Abstract getComponentsInChildren

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

  • Type Parameters

    • T

    Parameters

    • type: Constructor<T>
    • Optional arr: T[]

    Returns T[]

Abstract getComponentsInParent

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

  • Type Parameters

    • T

    Parameters

    • type: Constructor<T>
    • Optional arr: T[]

    Returns T[]

Abstract getOrAddComponent

  • getOrAddComponent<T>(typeName): T

  • Type Parameters

    • T

    Parameters

    • typeName: ConstructorConcrete<T>

    Returns T

Abstract removeComponent

  • removeComponent<T>(comp): T

  • Type Parameters

    • T extends IComponent

    Parameters

    • comp: T

    Returns T

Static add

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

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

    Parameters

    Returns void

Static addComponent

  • 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

    • Optional init: Partial<NoInternalNeedleEngineState<FilterStartingWith<FilterTypes<T, Function>, "_">>>

      optional init object to initialize the component with

    • Optional opts: {
          callAwake: boolean;
      }
      • callAwake: boolean

    Returns T

Static addNewComponent

  • addNewComponent<T>(go, type, init?, callAwake?): T

  • Type Parameters

    • T extends IComponent

    Parameters

    • go: Object3D<Object3DEventMap> | IGameObject
    • type: T | ConstructorConcrete<T>
    • Optional init: Partial<NoInternalNeedleEngineState<FilterStartingWith<FilterTypes<T, Function>, "_">>>
    • callAwake: boolean = true

    Returns T

    Deprecated

    Use addComponent

Static destroy

  • 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

Static destroySynced

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

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

    Parameters

    Returns void

Static findByGuid

Static findObjectOfType

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

  • Type Parameters

    • T extends IComponent

    Parameters

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

    Returns T

Static findObjectsOfType

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

  • Type Parameters

    • T extends IComponent

    Parameters

    Returns T[]

Static foreachComponent

  • 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) => any)

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

        • (comp): any

        • Parameters

          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

Static getAllComponents

Static getComponent

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

  • Gets a component on the provided object

    Type Parameters

    • T extends IComponent

    Parameters

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

    Returns T

Static getComponentInChildren

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

  • Type Parameters

    • T extends IComponent

    Parameters

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

    Returns T

Static getComponentInParent

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

  • Type Parameters

    • T extends IComponent

    Parameters

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

    Returns T

Static getComponents

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

  • Type Parameters

    • T extends IComponent

    Parameters

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

    Returns T[]

Static getComponentsInChildren

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

  • Type Parameters

    • T extends IComponent

    Parameters

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

    Returns T[]

Static getComponentsInParent

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

  • Type Parameters

    • T extends IComponent

    Parameters

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

    Returns T[]

Static getOrAddComponent

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

  • Type Parameters

    • T extends IComponent

    Parameters

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

    Returns T

Static instantiate

  • 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: IInstantiateOptions = null

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

    Returns GameObject

Static instantiateSynced

  • instantiateSynced(instance, opts): GameObject

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

    Parameters

    • instance: Object3D<Object3DEventMap> | GameObject

      object to instantiate

    • opts: IInstantiateOptions

      options for the instantiation

    Returns GameObject

Static invoke

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

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

    Parameters

    • go: 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

Static invokeOnChildren

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

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

    Parameters

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

    Returns void

Static isActiveInHierarchy

  • 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

Static isActiveSelf

  • isActiveSelf(go): boolean

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

    Parameters

    Returns boolean

Static isDestroyed

  • isDestroyed(go): boolean

  • Parameters

    Returns boolean

Static isUsingInstancing

  • isUsingInstancing(instance): boolean

  • Parameters

    Returns boolean

Static iterateComponents

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

  • Parameters

    • go: Object3D<Object3DEventMap> | IGameObject

    Returns Generator<any, void, unknown>

Static markAsInstancedRendered

  • markAsInstancedRendered(go, instanced): void

  • Parameters

    • go: Object3D<Object3DEventMap>
    • instanced: boolean

    Returns void

Static moveComponent

  • 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

Static remove

  • remove(instance): void

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

    Parameters

    Returns void

Static removeComponent

  • removeComponent<T>(instance): T

  • Removes a component from its object

    Type Parameters

    • T extends IComponent

    Parameters

    • instance: T

      component to remove

    Returns T

Static setActive

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

  • Parameters

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

    Returns void

Settings

Member Visibility

Theme

On This Page

constructortransformworldForwardworldPositionworldQuaternionworldRightworldRotationworldScaleworldUpaddComponentaddNewComponentdestroygetComponentgetComponentInChildrengetComponentInParentgetComponentsgetComponentsInChildrengetComponentsInParentgetOrAddComponentremoveComponentaddaddComponentaddNewComponentdestroydestroySyncedfindByGuidfindObjectOfTypefindObjectsOfTypeforeachComponentgetAllComponentsgetComponentgetComponentInChildrengetComponentInParentgetComponentsgetComponentsInChildrengetComponentsInParentgetOrAddComponentinstantiateinstantiateSyncedinvokeinvokeOnChildrenisActiveInHierarchyisActiveSelfisDestroyedisUsingInstancingiterateComponentsmarkAsInstancedRenderedmoveComponentremoveremoveComponentsetActive

Generated using TypeDoc