[Base Class](../groups/Base Class.Base Class.md) / GameObject

GameObject Class ​

Base class of all entities in the scene

Logical objects such as Model, Pawn, Camera, AdvancedVehicle, BlockingVolume, etc. inherit from GameObject.

Provide functions such as copying and deleting objects, searching for and obtaining objects, sub objects, scripts, etc.

Example usage: Create a script called "GameObjectiExample" to place the model cube, cylinder, and frustum in the scene, with a parent-child tree of cube/cylinder/frustum, and mount the GameObjectiExample script to the cube. The code is as follows:

@Component
export default class GameObjectExample extends Script {
    protected onStart(): void {
        let obj: GameObject = this.gameObject;
        console.log(`obj.name = ${obj.name}`);
        console.log(`obj.tag = ${obj.tag}`);
        console.log(`obj.worldTransform = ${obj.worldTransform}`);
        console.log(`obj.localTransform = ${obj.localTransform}`);
        let children = obj.getChildren();
        children.forEach(child => {
            console.log(`obj child = ${child.name}`);
        });
        let path = Cube/cylinder
        let cylinderObj = GameObject.getGameObjectByPath(path);
        console.log(`getGameObjectByPath = ${cylinderObj ? cylinderObj.name : "undefined"}`);
        path = "Cylinder/frustum"
        cylinderObj = obj.getChildByPath(path);
        console.log(`getChildByPath = ${cylinderObj ? cylinderObj.name : "undefined"}`);
        cylinderObj.onDestroyDelegate.add(()=>{
            console.log(`destroyDelegate 1 = ${cylinderObj ? cylinderObj.name : "undefined"}`);
        });
        cylinderObj.onDestroyDelegate.add(()=>{
            console.log(`destroyDelegate 2 = ${cylinderObj ? cylinderObj.name : "undefined"}`);
        });
        cylinderObj.destroy();
    }
}

@Component
export default class GameObjectExample extends Script {
    protected onStart(): void {
        let obj: GameObject = this.gameObject;
        console.log(`obj.name = ${obj.name}`);
        console.log(`obj.tag = ${obj.tag}`);
        console.log(`obj.worldTransform = ${obj.worldTransform}`);
        console.log(`obj.localTransform = ${obj.localTransform}`);
        let children = obj.getChildren();
        children.forEach(child => {
            console.log(`obj child = ${child.name}`);
        });
        let path = Cube/cylinder
        let cylinderObj = GameObject.getGameObjectByPath(path);
        console.log(`getGameObjectByPath = ${cylinderObj ? cylinderObj.name : "undefined"}`);
        path = "Cylinder/frustum"
        cylinderObj = obj.getChildByPath(path);
        console.log(`getChildByPath = ${cylinderObj ? cylinderObj.name : "undefined"}`);
        cylinderObj.onDestroyDelegate.add(()=>{
            console.log(`destroyDelegate 1 = ${cylinderObj ? cylinderObj.name : "undefined"}`);
        });
        cylinderObj.onDestroyDelegate.add(()=>{
            console.log(`destroyDelegate 2 = ${cylinderObj ? cylinderObj.name : "undefined"}`);
        });
        cylinderObj.destroy();
    }
}

Hierarchy ​

• Base

  ↳ GameObject

  ↳↳ Model

  ↳↳ Pawn

  ↳↳ Camera

  ↳↳ AdvancedVehicle

  ↳↳ BlockingVolume

  ↳↳ Effect

  ↳↳ IKAnchor

  ↳↳ ParticleEmitter

  ↳↳ Sound

  ↳↳ SwimmingVolume

  ↳↳ Trigger

  ↳↳ UIWidget

  ↳↳ WaterVolume

  ↳↳ HotWeapon

  ↳↳ Interactor

  ↳↳ PointLight

  ↳↳ NavModifierVolume

  ↳↳ RigidConstraint

  ↳↳ ForceVolume

  ↳↳ Impulse

  ↳↳ IntegratedMover

  ↳↳ PhysicsThruster

  ↳↳ ProjectileInst

  ↳↳ ObjectLauncher

  ↳↳ UIObject

Table of contents ​

Properties ​

Accessors ​

Methods ​

Properties ​

onBeforeDestroyDelegate ​

• onBeforeDestroyDelegate: MulticastDelegate<() => void> other

Event callback before object destruction

onCustomPropertyChange ​

• onCustomPropertyChange: Readonly<MulticastDelegate<(path: string, value: unknown, oldValue: unknown) => void>> other

Monitor custom attribute synchronization events

this.onCustomPropertyChange.add((path, value, oldValue) => {
    Console. log (the ` property ${path} change, the new value is ${value}, the old value is ${oldValue} `);
});

this.onCustomPropertyChange.add((path, value, oldValue) => {
    Console. log (the ` property ${path} change, the new value is ${value}, the old value is ${oldValue} `);
});

onDestroyDelegate ​

• onDestroyDelegate: MulticastDelegate<() => void> other

Event callback after object destruction

onPropertyChange ​

• onPropertyChange: Readonly<MulticastDelegate<(path: string, value: unknown, oldValue: unknown) => void>>

Monitor system replicated events

this.onPropertyChange.add((path, value, oldValue) => {
    Console. log (the ` property ${path} change, the new value is ${value}, the old value is ${oldValue} `);
});

this.onPropertyChange.add((path, value, oldValue) => {
    Console. log (the ` property ${path} change, the new value is ${value}, the old value is ${oldValue} `);
});

Accessors ​

actorFlagValue ​

actorLevel ​

assetId ​

gameObjectId ​

isDestroyed ​

isReady ​

localTransform ​

name ​

netStatus ​

parent ​

tag ​

worldTransform ​

Methods ​

addComponent ​

• addComponent<T>(constructor, bInReplicates?): T other

Add a script component

Parameters ​

Returns ​

Type parameters ​

asyncGetChildByName ​

• asyncGetChildByName(name): Promise<GameObject> other

Editor

Asynchronous search for sub objects based on their names

Parameters ​

Returns ​

asyncReady ​

• asyncReady(): Promise<GameObject> other

Return after the object is ready

Returns ​

clone ​

• clone(gameObjectInfo?): GameObject other

Editor

Copy Objects

Parameters ​

Returns ​

destroy ​

• destroy(): void other

delete object

getBoundingBox ​

• getBoundingBox(nonColliding?, includeFromChild?, outer?): Vector other

Get the size of the object's bounding box

Parameters ​

Returns ​

getBounds ​

• getBounds(onlyCollidingComponents, originOuter, boxExtentOuter, includeFromChild?): void other

Obtain object boundaries

Parameters ​

getChildByGameObjectId ​

• getChildByGameObjectId(gameObjectId): GameObject other

Search for sub objects based on gameObjectid

Parameters ​

Returns ​

getChildByName ​

• getChildByName(name): GameObject other

Editor

Search for sub objects by name

Parameters ​

Returns ​

getChildByPath ​

• getChildByPath(path): GameObject other

Find sub objects according to path

Parameters ​

Returns ​

getChildren ​

• getChildren(): GameObject[] other

Obtain sub objects

Returns ​

getChildrenBoundingBoxCenter ​

• getChildrenBoundingBoxCenter(outer?): Vector other

Get the center point of all child objects' bounding box (not including the parent object, if the parent object is unavailable, return [0,0,0])

Parameters ​

Returns ​

getChildrenByName ​

• getChildrenByName(name): GameObject[] other

Search for all sub objects by name

Parameters ​

Returns ​

getComponent ​

• getComponent<T>(constructor?): T other

Get the component of the specified type

Parameters ​

Returns ​

Usage example: Create a script named "NewScript1" and obtain the NewScript script through getComponent. The code is as follows:

import NewScript from "./NewScript";
@Component
export default class NewScript1 extends Script {
    protected onStart(): void {
        const script = this.gameObject.getComponent(NewScript);
    }
}

import NewScript from "./NewScript";
@Component
export default class NewScript1 extends Script {
    protected onStart(): void {
        const script = this.gameObject.getComponent(NewScript);
    }
}

Type parameters ​

getComponentPropertys ​

• getComponentPropertys<T>(constructor): Map<string, IPropertyOptions> other

Get property of script component

Parameters ​

Returns ​

Type parameters ​

getComponents ​

• getComponents<T>(constructor?): T[] other

Get all component of the specified type

Parameters ​

Returns ​

Type parameters ​

getCustomProperties ​

• getCustomProperties(): string[] other

Get all customize property

Returns ​

const attributes = this.getAttributes();
console.log(attributes);
// ["name", "age"]

const attributes = this.getAttributes();
console.log(attributes);
// ["name", "age"]

getCustomProperty ​

• getCustomProperty<T>(propertyName): T other

Get customize property

Parameters ​

Returns ​

Type parameters ​

getCustomPropertyChangeDelegate ​

• getCustomPropertyChangeDelegate(property): Readonly<MulticastDelegate<(path: string, value: unknown, oldValue: unknown) => void>> other

Event proxy triggered when a given object property is modified

Parameters ​

Returns ​

getPropertyChangeDelegate ​

• getPropertyChangeDelegate(property): Readonly<MulticastDelegate<(path: string, value: unknown, oldValue: unknown) => void>> other

Event proxy triggered when a given object property is modified

Parameters ​

Returns ​

getVisibility ​

• getVisibility(): boolean other

Obtain whether the object is displayed

Returns ​

isPrefabActor ​

• isPrefabActor(): boolean other

Editor

Return whether the current object is a prefabricated body

Returns ​

moveBy ​

• moveBy(velocity, isLocal?): void other

Smoothly move an object over time according to a given velocity vector

Parameters ​

Usage example: Calling method

let cube = GameObject.spawn<Model>("197386", {
   replicates: true,
   transform: new Transform()
});
cube.moveBy(new Vector(10, 10, 0), true);

let cube = GameObject.spawn<Model>("197386", {
   replicates: true,
   transform: new Transform()
});
cube.moveBy(new Vector(10, 10, 0), true);

moveTo ​

• moveTo(targetPosition, time, isLocal?, onComplete?): void other

Smoothly move from the current position to the target position within the specified time

Parameters ​

Usage example: Calling method

let cube = GameObject.spawn<Model>("197386", {
   replicates: true,
   transform: new Transform()
});
cube.moveTo(new Vector(1000, 0, 0), 10, true, () => {
   console.log("moveTo complete");
});

let cube = GameObject.spawn<Model>("197386", {
   replicates: true,
   transform: new Transform()
});
cube.moveTo(new Vector(1000, 0, 0), 10, true, () => {
   console.log("moveTo complete");
});

rotateBy ​

• rotateBy(rotation, multiplier, isLocal?): void other

Rotate the object smoothly over time according to the given rotation amount

Parameters ​

Usage example: Calling method

let cube = GameObject.spawn<Model>("197386", {
   replicates: true,
   transform: new Transform()
});
cube.rotateBy(new Rotation(1, 0, 1), 5, true);

let cube = GameObject.spawn<Model>("197386", {
   replicates: true,
   transform: new Transform()
});
cube.rotateBy(new Rotation(1, 0, 1), 5, true);

rotateTo ​

• rotateTo(targetRotation, time, isLocal?, onComplete?): void other

Smoothly changes from the current rotation to the target rotation within the specified time

Parameters ​

Usage example: Calling method

let cube = GameObject.spawn<Model>("197386", {
   replicates: true,
   transform: new Transform()
});
cube.rotateTo(new Rotation(45, 0, 0), 10, true, () => {
   console.log("rotateTo complete");
});

let cube = GameObject.spawn<Model>("197386", {
   replicates: true,
   transform: new Transform()
});
cube.rotateTo(new Rotation(45, 0, 0), 10, true, () => {
   console.log("rotateTo complete");
});

scaleBy ​

• scaleBy(scale, isLocal?): void other

Smoothly scale objects over time using a given scaling vector per second

Parameters ​

Usage example: Calling method

let cube = GameObject.spawn<Model>("197386", {
   replicates: true,
   transform: new Transform()
});
cube.scaleBy(new Vector(1, 1, 0), true);

let cube = GameObject.spawn<Model>("197386", {
   replicates: true,
   transform: new Transform()
});
cube.scaleBy(new Vector(1, 1, 0), true);

scaleTo ​

• scaleTo(targetScale, time, isLocal?, onComplete?): void other

Smoothly changes from the current scale to the target scale within the specified time

Parameters ​

Usage example: Calling method

let cube = GameObject.spawn<Model>("197386", {
   replicates: true,
   transform: new Transform()
});
cube.scaleTo(new Vector(2, 2, 0), 10, true, () => {
   console.log("scaleTo complete");
});

let cube = GameObject.spawn<Model>("197386", {
   replicates: true,
   transform: new Transform()
});
cube.scaleTo(new Vector(2, 2, 0), 10, true, () => {
   console.log("scaleTo complete");
});

setAbsolute ​

• setAbsolute(absolutePosition?, absoluteRotation?, absoluteScale?): void other

Editor

Set whether the object localTransform is relative to the parent object or the world

Parameters ​

setCustomProperty ​

• setCustomProperty(propertyName, value): void other

Set custom attributes

Parameters ​

setVisibility ​

• setVisibility(status, propagateToChildren?): void other

Set whether the object is displayed

Parameters ​

stopMove ​

• stopMove(): void other

Interrupt further movement of moveTo() and moveBy()

stopRotate ​

• stopRotate(): void other

Interrupt further rotation from rotateTo() or rotateBy()

stopScale ​

• stopScale(): void other

Interrupt further scale from ScaleTo() or ScaleBy()

asyncFindGameObjectById ​

• Static asyncFindGameObjectById(gameObjectId): Promise<GameObject> other

Asynchronous search for GameObject through gameObjectid

Parameters ​

Returns ​

The default is 10 seconds, which can be set through ScriptingSettings.setGlobalAsyncOverTime (1000 * 10).

asyncGetGameObjectByPath ​

• Static asyncGetGameObjectByPath(path): Promise<GameObject> other

Asynchronously find objects through path

Parameters ​

Returns ​

asyncSpawn ​

• Static asyncSpawn<T>(assetId, gameObjectInfo?): Promise<T> other

Asynchronous construction of an object

Parameters ​

Returns ​

If the resource does not exist, we will download it first and then create it

Usage example: Call method

let obj = await GameObject.asyncSpawn<Model>("197386", {
    replicates: true,
    transform: new Transform()
});

let obj = await GameObject.asyncSpawn<Model>("197386", {
    replicates: true,
    transform: new Transform()
});

Type parameters ​

bulkPivotTo ​

• Static bulkPivotTo(gameObjects, transforms): void other

Batch set position

Parameters ​

findGameObjectById ​

• Static findGameObjectById(gameObjectId): GameObject other

Search for objects through gameObjectid

Parameters ​

Returns ​

findGameObjectByName ​

• Static findGameObjectByName(name): GameObject other

Search for objects by name

Parameters ​

Returns ​

findGameObjectsByName ​

• Static findGameObjectsByName(name): GameObject[] other

Search for objects by name

Parameters ​

Returns ​

findGameObjectsByTag ​

• Static findGameObjectsByTag(tag): GameObject[] other

Get objects through customize tag

Parameters ​

Returns ​

getGameObjectByPath ​

• Static getGameObjectByPath(path): GameObject other

Search for objects through paths

Parameters ​

Returns ​

spawn ​

• Static spawn<T>(assetId, gameObjectInfo?): T other

Construct an object

Parameters ​

Returns ​

Usage example: Calling method

let obj = GameObject.spawn<Model>("197386", {
   replicates: true,
   transform: new Transform()
});

let obj = GameObject.spawn<Model>("197386", {
   replicates: true,
   transform: new Transform()
});

Type parameters ​