InterfaceObjectOwner`Beta`

Base class for entities which has object and component relationship such as Editor.Assets.Scene and Editor.Assets.ObjectPrefab.

interface ObjectOwner {
    cacheFile: Path;
    fileMeta: AssetImportMetadata;
    id: Uuid;
    name: string;
    rootSceneObjects: SceneObject[];
    sceneObjects: SceneObject[];
    type: string;
    addSceneObject(parent: SceneObject): SceneObject;
    createSceneObject(name: string): SceneObject;
    findComponents(entityType: string): Component[];
    getDirectlyReferencedEntities(): Entity[];
    getOwnedEntities(): Entity[];
    getRootObjectIndex(object: SceneObject): number;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
    remapReferences(referenceMapping: object): void;
    reparentSceneObject(object: SceneObject, newParent: SceneObject, position?: number): void;
}

Hierarchy (view full)

Editor.Assets.Asset
- ObjectOwner
  - ObjectPrefab
  - Scene

Index

Properties

cacheFile fileMeta id name rootSceneObjects sceneObjects type

Methods

addSceneObject createSceneObject findComponents getDirectlyReferencedEntities getOwnedEntities getRootObjectIndex getTypeName isOfType isSame remapReferences reparentSceneObject

Properties

`Readonly` `Beta`cacheFile

cacheFile: Path

`Readonly` `Beta`fileMeta

fileMeta: AssetImportMetadata

`Readonly` `Beta`id

id: Uuid

The unique id of the entity.

`Readonly` `Beta`name

name: string

The name of the asset.

`Readonly` `Beta`rootSceneObjects

rootSceneObjects: SceneObject[]

A list of scene objects which is a direct child of this entity.

`Readonly` `Beta`sceneObjects

sceneObjects: SceneObject[]

A list of scene objects which is a child of this entity.

`Readonly` `Beta`type

type: string

The entity's type.

Methods

addSceneObject

addSceneObject(parent): SceneObject
Beta
Adds a scene object to the entity.
Parameters
- parent: SceneObject
Returns SceneObject

createSceneObject

createSceneObject(name): SceneObject
Beta
Creates a scene object to the entity.
Parameters
- name: string
Returns SceneObject

findComponents

findComponents(entityType): Component[]
Beta
Find components on the entity.
Parameters
- entityType: string
Returns Component[]

getDirectlyReferencedEntities

getDirectlyReferencedEntities(): Entity[]
Beta
A list of entities which this entity has a reference to.

Returns Entity[]
Inherited from Asset.getDirectlyReferencedEntities

getOwnedEntities

getOwnedEntities(): Entity[]
Beta
A list of entities which has a reference to this entity.

Returns Entity[]
Inherited from Asset.getOwnedEntities

getRootObjectIndex

getRootObjectIndex(object): number
Beta
Get the index of object within the list of all the root objects.
Parameters
- object: SceneObject
Returns number

getTypeName

getTypeName(): string
Beta
Returns string
Inherited from Asset.getTypeName

isOfType

isOfType(type): boolean
Beta
Parameters
- type: string
Returns boolean
Inherited from Asset.isOfType

isSame

isSame(other): boolean
Beta
Parameters
- other: ScriptObject
Returns boolean
Inherited from Asset.isSame

remapReferences

remapReferences(referenceMapping): void
Beta
Swap this entity for another one based on a JSON of the current entity id and the target entity id.
Parameters
- referenceMapping: object
Returns void
Inherited from Asset.remapReferences

reparentSceneObject

reparentSceneObject(object, newParent, position?): void
Beta
Reparent the scene object to another scene object. You can use this to reparent objects to the root (i.e. pass in null).
Parameters
- object: SceneObject
- newParent: SceneObject
- Optionalposition: number
Returns void