Class GameObject`Abstract`

Base class for objects in Needle Engine. Extends Object3D from three.js. GameObjects can have components attached to them, which can be used to add functionality to the object. They manage their components and provide methods to add, remove and get components.

All Object3D types loaded in Needle Engine have methods like addComponent. These methods are available directly on the GameObject instance:

target.addComponent(MyComponent);

And can be called statically on the GameObject class as well:

GameObject.setActive(target, true);

Hierarchy

Object3D
- GameObject

Implements

Constructors

constructor

new GameObject(): GameObject
This creates a new Object3D object.

Returns GameObject
Inherited from Object3D.constructor

Properties

`Abstract`activeSelf

activeSelf: boolean

Indicates if the GameObject is currently active. Inactive GameObjects will not be rendered or updated. When the activeSelf state changes, components will receive Component.onEnable or Component.onDisable callbacks.

guid

guid: undefined | string

Unique identifier for this GameObject

hideFlags

hideFlags: HideFlags

Allows to control e.g. if an object should be exported

Accessors

`Abstract`worldForward

get worldForward(): Vector3
The forward direction vector of this GameObject in world space

Returns Vector3
Implementation of Object3D.worldForward
Overrides Object3D.worldForward

`Abstract`worldPosition

get worldPosition(): Vector3
The position of this GameObject in world space

Returns Vector3
Implementation of Object3D.worldPosition
Overrides Object3D.worldPosition
set worldPosition(val: Vector3): void
Get or set the world position of the Object3D.
Added by Needle Engine.
Parameters
- val: Vector3
Returns void
Implementation of Object3D.worldPosition
Overrides Object3D.worldPosition

`Abstract`worldQuaternion

get worldQuaternion(): Quaternion
Get or set the world quaternion of the Object3D.
Added by Needle Engine.

Returns Quaternion
Implementation of Object3D.worldQuaternion
Overrides Object3D.worldQuaternion
set worldQuaternion(val: Quaternion): void
The rotation of this GameObject in world space as a quaternion
Parameters
- val: Quaternion
Returns void
Implementation of Object3D.worldQuaternion
Overrides Object3D.worldQuaternion

`Abstract`worldRight

get worldRight(): Vector3
The right direction vector of this GameObject in world space

Returns Vector3
Implementation of Object3D.worldRight
Overrides Object3D.worldRight

`Abstract`worldRotation

get worldRotation(): Vector3
Get or set the world rotation of the Object3D.
Added by Needle Engine.

Returns Vector3
Implementation of Object3D.worldRotation
Overrides Object3D.worldRotation
set worldRotation(val: Vector3): void
The rotation of this GameObject in world space in euler angles (degrees)
Parameters
- val: Vector3
Returns void
Implementation of Object3D.worldRotation
Overrides Object3D.worldRotation

`Abstract`worldScale

get worldScale(): Vector3
Get or set the world scale of the Object3D.
Added by Needle Engine.

Returns Vector3
Implementation of Object3D.worldScale
Overrides Object3D.worldScale
set worldScale(val: Vector3): void
The scale of this GameObject in world space
Parameters
- val: Vector3
Returns void
Implementation of Object3D.worldScale
Overrides Object3D.worldScale

`Abstract`worldUp

get worldUp(): Vector3
The up direction vector of this GameObject in world space

Returns Vector3
Implementation of Object3D.worldUp
Overrides Object3D.worldUp

Methods

`Abstract`addComponent

addComponent<T extends IComponent>(
    comp: T | ConstructorConcrete<T>,
    init?: Partial<
        NoInternalNeedleEngineState<
            FilterStartingWith<FilterTypes<T, undefined | null | Function>, "_">,
        >,
    >,
): T
Creates a new component on this gameObject or adds an existing component instance
Type Parameters
- T extends IComponent
Parameters
- comp: T | ConstructorConcrete<T>
  Component type constructor or existing component instance
- Optionalinit: Partial<
      NoInternalNeedleEngineState<
          FilterStartingWith<FilterTypes<T, undefined | null | Function>, "_">,
      >,
  >
  Optional initialization values for the component
Returns T
The newly created or added component

Implementation of IGameObject.addComponent
Overrides Object3D.addComponent

`Abstract`addNewComponent

addNewComponent<T extends IComponent>(
    type: ConstructorConcrete<T>,
    init?: Partial<
        NoInternalNeedleEngineState<
            FilterStartingWith<FilterTypes<T, undefined | null | Function>, "_">,
        >,
    >,
): T
Type Parameters
- T extends IComponent
Parameters
- type: ConstructorConcrete<T>
- Optionalinit: Partial<
      NoInternalNeedleEngineState<
          FilterStartingWith<FilterTypes<T, undefined | null | Function>, "_">,
      >,
  >
Returns T
Deprecated
Use addComponent instead

Implementation of IGameObject.addNewComponent

`Abstract`destroy

destroy(): any
Destroys this GameObject and all its components. Internally, this is added to the three.js Object3D prototype.

Returns any
Implementation of IGameObject.destroy
Overrides Object3D.destroy

`Abstract`getComponent

getComponent<T>(type: Constructor<T>): null | T
Gets a component of the specified type attached to this GameObject
Type Parameters
- T
Parameters
- type: Constructor<T>
  Constructor of the component type to get
Returns null | T
The component if found, otherwise null

Implementation of IGameObject.getComponent
Overrides Object3D.getComponent

`Abstract`getComponentInChildren

getComponentInChildren<T>(type: Constructor<T>): null | T
Gets a component of the specified type in this GameObject's children hierarchy
Type Parameters
- T
Parameters
- type: Constructor<T>
  Constructor of the component type to get
Returns null | T
The first matching component if found, otherwise null

Implementation of IGameObject.getComponentInChildren
Overrides Object3D.getComponentInChildren

`Abstract`getComponentInParent

getComponentInParent<T>(type: Constructor<T>): null | T
Gets a component of the specified type in this GameObject's parent hierarchy
Type Parameters
- T
Parameters
- type: Constructor<T>
  Constructor of the component type to get
Returns null | T
The first matching component if found, otherwise null

Implementation of IGameObject.getComponentInParent
Overrides Object3D.getComponentInParent

`Abstract`getComponents

getComponents<T>(type: Constructor<T>, arr?: T[]): T[]
Gets all components of the specified type attached to this GameObject
Type Parameters
- T
Parameters
- type: Constructor<T>
  Constructor of the component type to get
- Optionalarr: T[]
  Optional array to populate with the components
Returns T[]
Array of components

Implementation of IGameObject.getComponents
Overrides Object3D.getComponents

`Abstract`getComponentsInChildren

getComponentsInChildren<T>(type: Constructor<T>, arr?: T[]): T[]
Gets all components of the specified type in this GameObject's children hierarchy
Type Parameters
- T
Parameters
- type: Constructor<T>
  Constructor of the component type to get
- Optionalarr: T[]
  Optional array to populate with the components
Returns T[]
Array of components

Implementation of IGameObject.getComponentsInChildren
Overrides Object3D.getComponentsInChildren

`Abstract`getComponentsInParent

getComponentsInParent<T>(type: Constructor<T>, arr?: T[]): T[]
Gets all components of the specified type in this GameObject's parent hierarchy
Type Parameters
- T
Parameters
- type: Constructor<T>
  Constructor of the component type to get
- Optionalarr: T[]
  Optional array to populate with the components
Returns T[]
Array of components

Implementation of IGameObject.getComponentsInParent
Overrides Object3D.getComponentsInParent

`Abstract`getOrAddComponent

getOrAddComponent<T>(typeName: null | ConstructorConcrete<T>): T
Gets an existing component of the specified type or adds a new one if it doesn't exist
Type Parameters
- T
Parameters
- typeName: null | ConstructorConcrete<T>
  Constructor of the component type to get or add
Returns T
The existing or newly added component

Implementation of IGameObject.getOrAddComponent
Overrides Object3D.getOrAddComponent

`Abstract`removeComponent

removeComponent<T extends IComponent>(comp: T): T
Removes a component from this GameObject
Type Parameters
- T extends IComponent
Parameters
- comp: T
  Component instance to remove
Returns T
The removed component

Implementation of IGameObject.removeComponent
Overrides Object3D.removeComponent

`Static`add

add(
    instance: undefined | null | Object3D<Object3DEventMap>,
    parent: Object3D,
    context?: Context,
): void
Adds an object to parent and ensures all components are properly registered
Parameters
- instance: undefined | null | Object3D<Object3DEventMap>
  Object to add
- parent: Object3D
  Parent to add the object to
- Optionalcontext: Context
  Optional context to use
Returns void

`Static`addComponent

addComponent<T extends IComponent>(
    go: Object3D<Object3DEventMap> | IGameObject,
    instanceOrType: T | ConstructorConcrete<T>,
    init?: Partial<
        NoInternalNeedleEngineState<
            FilterStartingWith<FilterTypes<T, undefined | null | Function>, "_">,
        >,
    >,
    opts?: { callAwake: boolean },
): T
Adds a new component (or moves 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
- Optionalinit: Partial<
      NoInternalNeedleEngineState<
          FilterStartingWith<FilterTypes<T, undefined | null | Function>, "_">,
      >,
  >
  Optional init object to initialize the component with
- Optionalopts: { callAwake: boolean }
  Optional options for adding the component
Returns T
The added or moved component

`Static`addNewComponent

addNewComponent<T extends IComponent>(
    go: Object3D<Object3DEventMap> | IGameObject,
    type: T | ConstructorConcrete<T>,
    init?: Partial<
        NoInternalNeedleEngineState<
            FilterStartingWith<FilterTypes<T, undefined | null | Function>, "_">,
        >,
    >,
    callAwake?: boolean,
): T
Type Parameters
- T extends IComponent
Parameters
- go: Object3D<Object3DEventMap> | IGameObject
- type: T | ConstructorConcrete<T>
- Optionalinit: Partial<
      NoInternalNeedleEngineState<
          FilterStartingWith<FilterTypes<T, undefined | null | Function>, "_">,
      >,
  >
- callAwake: boolean = true
Returns T
Deprecated
use addComponent

`Static`destroy

destroy(
instance: Object3D<Object3DEventMap> | Behaviour,
recursive?: boolean,
): void
Destroys an object
Parameters
- instance: Object3D<Object3DEventMap> | Behaviour
  Object to destroy
- recursive: boolean = true
  If true, all children will be destroyed as well. Default: true
Returns void

`Static`destroySynced

destroySynced(
    instance: Object3D<Object3DEventMap> | Behaviour,
    context?: Context,
    recursive?: boolean,
): void
Destroys an object on all connected clients (if in a networked session)
Parameters
- instance: Object3D<Object3DEventMap> | Behaviour
  Object to destroy
- Optionalcontext: Context
  Optional context to use
- recursive: boolean = true
  If true, all children will be destroyed as well
Returns void

`Static`findByGuid

findByGuid(
guid: string,
hierarchy: Object3D,
): undefined | null | Behaviour | GameObject
Finds an object or component by its unique identifier
Parameters
- guid: string
  Unique identifier to search for
- hierarchy: Object3D
  Root object to search in
Returns undefined | null | Behaviour | GameObject
The found GameObject or Component, or null/undefined if not found

`Static`findObjectOfType

findObjectOfType<T extends IComponent>(
    typeName: Constructor<T>,
    context?: Object3D<Object3DEventMap> | Context,
    includeInactive?: boolean,
): null | T
Finds the first object of the specified component type in the scene
Type Parameters
- T extends IComponent
Parameters
- typeName: Constructor<T>
  Constructor of the component type
- Optionalcontext: Object3D<Object3DEventMap> | Context
  Context or root object to search in
- includeInactive: boolean = true
  Whether to include inactive objects in the search
Returns null | T
The first matching component if found, otherwise null

`Static`findObjectsOfType

findObjectsOfType<T extends IComponent>(
typeName: Constructor<T>,
context?: Object3D<Object3DEventMap> | Context,
): T[]
Finds all objects of the specified component type in the scene
Type Parameters
- T extends IComponent
Parameters
- typeName: Constructor<T>
  Constructor of the component type
- Optionalcontext: Object3D<Object3DEventMap> | Context
  Context or root object to search in
Returns T[]
Array of matching components

`Static`foreachComponent

foreachComponent(
    instance: Object3D,
    cb: (comp: Behaviour) => any,
    recursive?: boolean,
): any
Executes a callback for all components of the provided type on the provided object and its children
Parameters
- instance: Object3D
  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
- 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

getAllComponents(go: Object3D<Object3DEventMap> | IGameObject): Behaviour[]
Gets all components on the gameObject
Parameters
- go: Object3D<Object3DEventMap> | IGameObject
  GameObject to get components from
Returns Behaviour[]
Array of all components

`Static`getComponent

getComponent<T extends IComponent>(
go: null | Object3D<Object3DEventMap> | IGameObject,
typeName: null | Constructor<T>,
): null | T
Gets a component on the provided object
Type Parameters
- T extends IComponent
Parameters
- go: null | Object3D<Object3DEventMap> | IGameObject
  GameObject to get the component from
- typeName: null | Constructor<T>
  Constructor of the component type
Returns null | T
The component if found, otherwise null

`Static`getComponentInChildren

getComponentInChildren<T extends IComponent>(
go: Object3D<Object3DEventMap> | IGameObject,
typeName: Constructor<T>,
): null | T
Gets a component of the specified type in the gameObject's children hierarchy
Type Parameters
- T extends IComponent
Parameters
- go: Object3D<Object3DEventMap> | IGameObject
  GameObject to search in
- typeName: Constructor<T>
  Constructor of the component type
Returns null | T
The first matching component if found, otherwise null

`Static`getComponentInParent

getComponentInParent<T extends IComponent>(
go: Object3D<Object3DEventMap> | IGameObject,
typeName: Constructor<T>,
): null | T
Gets a component of the specified type in the gameObject's parent hierarchy
Type Parameters
- T extends IComponent
Parameters
- go: Object3D<Object3DEventMap> | IGameObject
  GameObject to search in
- typeName: Constructor<T>
  Constructor of the component type
Returns null | T
The first matching component if found, otherwise null

`Static`getComponents

getComponents<T extends IComponent>(
    go: null | Object3D<Object3DEventMap> | IGameObject,
    typeName: Constructor<T>,
    arr?: null | T[],
): T[]
Gets all components of the specified type on the provided object
Type Parameters
- T extends IComponent
Parameters
- go: null | Object3D<Object3DEventMap> | IGameObject
  GameObject to get the components from
- typeName: Constructor<T>
  Constructor of the component type
- arr: null | T[] = null
  Optional array to populate with the components
Returns T[]
Array of components

`Static`getComponentsInChildren

getComponentsInChildren<T extends IComponent>(
    go: Object3D<Object3DEventMap> | IGameObject,
    typeName: Constructor<T>,
    arr?: null | T[],
): T[]
Gets all components of the specified type in the gameObject's children hierarchy
Type Parameters
- T extends IComponent
Parameters
- go: Object3D<Object3DEventMap> | IGameObject
  GameObject to search in
- typeName: Constructor<T>
  Constructor of the component type
- arr: null | T[] = null
  Optional array to populate with the components
Returns T[]
Array of components

`Static`getComponentsInParent

getComponentsInParent<T extends IComponent>(
    go: Object3D<Object3DEventMap> | IGameObject,
    typeName: Constructor<T>,
    arr?: null | T[],
): T[]
Gets all components of the specified type in the gameObject's parent hierarchy
Type Parameters
- T extends IComponent
Parameters
- go: Object3D<Object3DEventMap> | IGameObject
  GameObject to search in
- typeName: Constructor<T>
  Constructor of the component type
- arr: null | T[] = null
  Optional array to populate with the components
Returns T[]
Array of components

`Static`getOrAddComponent

getOrAddComponent<T extends IComponent>(
go: Object3D<Object3DEventMap> | IGameObject,
typeName: ConstructorConcrete<T>,
): T
Gets or adds a component of the specified type
Type Parameters
- T extends IComponent
Parameters
- go: Object3D<Object3DEventMap> | IGameObject
  GameObject to get or add the component to
- typeName: ConstructorConcrete<T>
  Constructor of the component type
Returns T
The existing or newly added component

`Static`instantiate

instantiate(
instance: AssetReference,
opts?: null | IInstantiateOptions,
): Promise<null | Object3D<Object3DEventMap>>
Creates a new instance of the provided object (like cloning it including all components and children)
Parameters
- instance: AssetReference
  Object to instantiate
- Optionalopts: null | IInstantiateOptions
  Options for the instantiation (e.g. with what parent, position, etc.)
Returns Promise<null | Object3D<Object3DEventMap>>
The newly created instance
instantiate(
instance: Object3D<Object3DEventMap> | GameObject,
opts?: null | IInstantiateOptions,
): 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
- Optionalopts: null | IInstantiateOptions
  Options for the instantiation (e.g. with what parent, position, etc.)
Returns GameObject
The newly created instance

`Static`instantiateSynced

instantiateSynced(
instance: null | Object3D<Object3DEventMap> | GameObject,
opts: SyncInstantiateOptions,
): null | GameObject
Creates a new instance of the provided object that will be replicated to all connected clients
Parameters
- instance: null | Object3D<Object3DEventMap> | GameObject
  Object to instantiate
- opts: SyncInstantiateOptions
  Options for the instantiation
Returns null | GameObject
The newly created instance or null if creation failed

`Static`invoke

invoke(
    go: undefined | null | Object3D<Object3DEventMap>,
    functionName: string,
    children?: boolean,
    ...args: any,
): void
Invokes a method on all components that have a method matching the provided name
Parameters
- go: undefined | null | Object3D<Object3DEventMap>
  GameObject to invoke the method on
- functionName: string
  Name of the method to invoke
- children: boolean = false
  Whether to invoke on children as well
- ...args: any
  Arguments to pass to the method
Returns void

`Static`invokeOnChildren

invokeOnChildren(
    go: undefined | null | Object3D<Object3DEventMap>,
    functionName: string,
    ...args: any,
): void
Invokes a method on all components including children (if a method with that name exists)
Parameters
- go: undefined | null | Object3D<Object3DEventMap>
  GameObject to invoke the method on
- functionName: string
  Name of the method to invoke
- ...args: any
  Arguments to pass to the method
Returns void

`Static`isActiveInHierarchy

isActiveInHierarchy(go: Object3D): boolean
Checks if the GameObject is active in the hierarchy (e.g. if any parent is invisible or not in the scene it will be false)
Parameters
- go: Object3D
  The GameObject to check
Returns boolean
True if the GameObject is active in the hierarchy

`Static`isActiveSelf

isActiveSelf(go: Object3D): boolean
Checks if the GameObject itself is active (same as go.visible)
Parameters
- go: Object3D
  The GameObject to check
Returns boolean
True if the GameObject is active

`Static`isDestroyed

isDestroyed(go: Object3D): boolean
Checks if a GameObject has been destroyed
Parameters
- go: Object3D
  The GameObject to check
Returns boolean
True if the GameObject has been destroyed

`Static`isUsingInstancing

isUsingInstancing(instance: Object3D): boolean
Checks if a GameObject is using instanced rendering
Parameters
- instance: Object3D
  The GameObject to check
Returns boolean
True if the GameObject is using instanced rendering

`Static`iterateComponents

iterateComponents(
go: Object3D<Object3DEventMap> | IGameObject,
): Generator<any, void, unknown>
Iterates through all components on the gameObject
Parameters
- go: Object3D<Object3DEventMap> | IGameObject
  GameObject to iterate components on
Returns Generator<any, void, unknown>
Generator yielding each component

`Static`markAsInstancedRendered

markAsInstancedRendered(go: Object3D, instanced: boolean): void
Marks a GameObject to be rendered using instancing
Parameters
- go: Object3D
  The GameObject to mark
- instanced: boolean
  Whether the GameObject should use instanced rendering
Returns void

`Static`moveComponent

moveComponent<T extends IComponent>(
go: Object3D<Object3DEventMap> | IGameObject,
instance: T | ConstructorConcrete<T>,
): T
Moves a component to a new object
Type Parameters
- T extends IComponent
Parameters
- go: Object3D<Object3DEventMap> | IGameObject
  GameObject to move the component to
- instance: T | ConstructorConcrete<T>
  Component to move
Returns T
The moved component

`Static`remove

remove(instance: undefined | null | Object3D<Object3DEventMap>): void
Removes the object from its parent and deactivates all of its components
Parameters
- instance: undefined | null | Object3D<Object3DEventMap>
  Object to remove
Returns void

`Static`removeComponent

removeComponent<T extends IComponent>(instance: T): T
Removes a component from its object
Type Parameters
- T extends IComponent
Parameters
- instance: T
  Component to remove
Returns T
The removed component

`Static`setActive

setActive(go: Object3D, active: boolean, processStart?: boolean): void
Sets the active state of a GameObject
Parameters
- go: Object3D
  The GameObject to modify
- active: boolean
  Whether the GameObject should be active
- processStart: boolean = true
  Whether to process the start callbacks if being activated
Returns void

Class GameObjectAbstract

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns GameObject

Properties

AbstractactiveSelf

guid

hideFlags

Accessors

AbstractworldForward

Returns Vector3

AbstractworldPosition

Returns Vector3

Parameters

Returns void

AbstractworldQuaternion

Returns Quaternion

Parameters

Returns void

AbstractworldRight

Returns Vector3

AbstractworldRotation

Returns Vector3

Parameters

Returns void

AbstractworldScale

Returns Vector3

Parameters

Returns void

AbstractworldUp

Returns Vector3

Methods

AbstractaddComponent

Type Parameters

Parameters

Returns T

AbstractaddNewComponent

Type Parameters

Parameters

Returns T

Deprecated

Abstractdestroy

Returns any

AbstractgetComponent

Type Parameters

Parameters

Returns null | T

AbstractgetComponentInChildren

Type Parameters

Parameters

Returns null | T

AbstractgetComponentInParent

Type Parameters

Parameters

Returns null | T

AbstractgetComponents

Type Parameters

Parameters

Returns T[]

AbstractgetComponentsInChildren

Type Parameters

Parameters

Returns T[]

AbstractgetComponentsInParent

Type Parameters

Parameters

Returns T[]

AbstractgetOrAddComponent

Type Parameters

Parameters

Returns T

AbstractremoveComponent

Type Parameters

Class GameObject`Abstract`

`Abstract`activeSelf

`Abstract`worldForward

`Abstract`worldPosition

`Abstract`worldQuaternion

`Abstract`worldRight

`Abstract`worldRotation

`Abstract`worldScale

`Abstract`worldUp

`Abstract`addComponent

`Abstract`addNewComponent

`Abstract`destroy

`Abstract`getComponent

`Abstract`getComponentInChildren

`Abstract`getComponentInParent

`Abstract`getComponents

`Abstract`getComponentsInChildren

`Abstract`getComponentsInParent

`Abstract`getOrAddComponent

`Abstract`removeComponent

`Static`add

`Static`addComponent

`Static`addNewComponent

`Static`destroy

`Static`destroySynced

`Static`findByGuid

`Static`findObjectOfType

`Static`findObjectsOfType

`Static`foreachComponent

`Static`getAllComponents

`Static`getComponent

`Static`getComponentInChildren

`Static`getComponentInParent

`Static`getComponents

`Static`getComponentsInChildren

`Static`getComponentsInParent

`Static`getOrAddComponent

`Static`instantiate