Class GameObject`Abstract`

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

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

if the object is enabled in the hierarchy (usually equivalent to visible)

guid

guid: undefined | string

the object's unique identifier

Accessors

`Abstract`transform

get transform(): GameObject
NOTE: this is just a wrapper for devs coming from Unity. Please use this.gameObject instead. In Needle Engine this.gameObject is the same as this.gameObject.transform. See the tutorial link below for more information

Returns GameObject
Tutorial
https://fwd.needle.tools/needle-engine/docs/transform

Implementation of IGameObject.transform

`Abstract`worldForward

get worldForward(): Vector3
Get the world forward vector of the Object3D.
Added by Needle Engine.

Returns Vector3
Implementation of Object3D.worldForward
Overrides Object3D.worldForward

`Abstract`worldPosition

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

Returns Vector3
Implementation of Object3D.worldPosition
Overrides Object3D.worldPosition
set worldPosition(val): 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): void
Get or set the world quaternion of the Object3D.
Added by Needle Engine.
Parameters
- val: Quaternion
Returns void
Implementation of Object3D.worldQuaternion
Overrides Object3D.worldQuaternion

`Abstract`worldRight

get worldRight(): Vector3
Get the world right vector of the Object3D.
Added by Needle Engine.

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): void
Get or set the world rotation of the Object3D.
Added by Needle Engine.
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): void
Get or set the world scale of the Object3D.
Added by Needle Engine.
Parameters
- val: Vector3
Returns void
Implementation of Object3D.worldScale
Overrides Object3D.worldScale

`Abstract`worldUp

get worldUp(): Vector3
Get the world up vector of the Object3D.
Added by Needle Engine.

Returns Vector3
Implementation of Object3D.worldUp
Overrides Object3D.worldUp

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>
- Optionalinit: Partial<NoInternalNeedleEngineState<FilterStartingWith<FilterTypes<T, undefined | null | Function>, "_">>>
Returns T
Implementation of IGameObject.addComponent
Overrides Object3D.addComponent

`Abstract`addNewComponent

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

Implementation of IGameObject.addNewComponent

`Abstract`destroy

destroy(): any
Destroys the Object3D and all its Needle Engine components.

Returns any
Implementation of IGameObject.destroy
Overrides Object3D.destroy

`Abstract`getComponent

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.

Implementation of IGameObject.getComponent
Overrides Object3D.getComponent

`Abstract`getComponentInChildren

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.

Implementation of IGameObject.getComponentInChildren
Overrides Object3D.getComponentInChildren

`Abstract`getComponentInParent

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.

Implementation of IGameObject.getComponentInParent
Overrides Object3D.getComponentInParent

`Abstract`getComponents

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.

Implementation of IGameObject.getComponents
Overrides Object3D.getComponents

`Abstract`getComponentsInChildren

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.

Implementation of IGameObject.getComponentsInChildren
Overrides Object3D.getComponentsInChildren

`Abstract`getComponentsInParent

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.

Implementation of IGameObject.getComponentsInParent
Overrides Object3D.getComponentsInParent

`Abstract`getOrAddComponent

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.

Implementation of IGameObject.getOrAddComponent
Overrides Object3D.getOrAddComponent

`Abstract`removeComponent

removeComponent<T>(comp): T
Remove a Needle Engine component from the Object3D.
Type Parameters
- T extends IComponent
Parameters
- comp: T
Returns T
Implementation of IGameObject.removeComponent
Overrides Object3D.removeComponent

`Static`add

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

`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
- Optionalinit: Partial<NoInternalNeedleEngineState<FilterStartingWith<FilterTypes<T, undefined | null | Function>, "_">>>
  optional init object to initialize the component with
- Optionalopts: {
  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>
- Optionalinit: Partial<NoInternalNeedleEngineState<FilterStartingWith<FilterTypes<T, undefined | null | 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
- instance: Object3D<Object3DEventMap> | Behaviour
  object to destroy
- Optionalcontext: Context
- recursive: boolean = true
Returns void

`Static`findByGuid

findByGuid(guid, hierarchy):
    | undefined
    | null
    | Behaviour
    | GameObject
Parameters
- guid: string
- hierarchy: Object3D<Object3DEventMap>
Returns
    | undefined
    | null
    | Behaviour
    | GameObject

`Static`findObjectOfType

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

`Static`findObjectsOfType

findObjectsOfType<T>(typeName, context?): T[]
Type Parameters
- T extends IComponent
Parameters
- typeName: Constructor<T>
- Optionalcontext: Object3D<Object3DEventMap> | Context
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: 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

`Static`getAllComponents

getAllComponents(go): Behaviour[]
Parameters
- go: Object3D<Object3DEventMap> | IGameObject
Returns Behaviour[]

`Static`getComponent

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

`Static`getComponentInChildren

getComponentInChildren<T>(go, typeName): null | T
Type Parameters
- T extends IComponent
Parameters
- go: Object3D<Object3DEventMap> | IGameObject
- typeName: Constructor<T>
Returns null | T

`Static`getComponentInParent

getComponentInParent<T>(go, typeName): null | T
Type Parameters
- T extends IComponent
Parameters
- go: Object3D<Object3DEventMap> | IGameObject
- typeName: Constructor<T>
Returns null | T

`Static`getComponents

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[]

`Static`getComponentsInChildren

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[]

`Static`getComponentsInParent

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[]

`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: null | IInstantiateOptions = null
  options for the instantiation (e.g. with what parent, position, etc.)
Returns GameObject

`Static`instantiateSynced

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: IInstantiateOptions
  options for the instantiation
Returns null | 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: 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

`Static`invokeOnChildren

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

`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
- go: Object3D<Object3DEventMap>
Returns boolean

`Static`isDestroyed

isDestroyed(go): boolean
Parameters
- go: Object3D<Object3DEventMap>
Returns boolean

`Static`isUsingInstancing

isUsingInstancing(instance): boolean
Parameters
- instance: Object3D<Object3DEventMap>
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
- instance: undefined | null | Object3D<Object3DEventMap>
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

Class GameObjectAbstract

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns GameObject

Properties

AbstractactiveSelf

guid

Accessors

Abstracttransform

Returns GameObject

Tutorial

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

Class GameObject`Abstract`

`Abstract`activeSelf

`Abstract`transform

`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

Returns
| undefined
| null
| Behaviour
| GameObject

`Static`findObjectOfType

`Static`findObjectsOfType

`Static`foreachComponent

`Static`getAllComponents

`Static`getComponent

`Static`getComponentInChildren

`Static`getComponentInParent

`Static`getComponents

`Static`getComponentsInChildren

`Static`getComponentsInParent

`Static`getOrAddComponent