Class TypeScriptAsset`Beta`

Hierarchy (View Summary, Expand)

ScriptAsset
- TypeScriptAsset

Index

Constructors

Properties

cacheFile componentId description exportId fileMeta icon id name type version

Methods

getDirectlyReferencedEntities getOwnedEntities getTypeName isOfType isSame isScriptInputHidden remapReferences setScriptInputHidden

Constructors

`Protected`constructor

new TypeScriptAsset(): TypeScriptAsset
Beta
Returns TypeScriptAsset
Overrides ScriptAsset.constructor

Properties

`Readonly` `Beta`cacheFile

cacheFile: Path

`Readonly` `Beta`componentId

componentId: Uuid

Id associated with the script asset.

`Beta`description

description: string

Description associated with the script asset

`Readonly` `Beta`exportId

exportId: Uuid

Export id associated with the script asset.

`Readonly` `Beta`fileMeta

fileMeta: Editor.Model.AssetImportMetadata

`Beta`icon

icon: Icon

Icon associated with the script asset.

`Readonly` `Beta`id

id: Uuid

The unique id of the entity.

`Readonly` `Beta`name

name: string

The name of the asset.

`Readonly` `Beta`type

type: string

The entity's type.

`Beta`version

version: Version

Version associated with the script asset.

Methods

getDirectlyReferencedEntities

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

Returns Entity[]
Inherited from ScriptAsset.getDirectlyReferencedEntities

getOwnedEntities

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

Returns Entity[]
Inherited from ScriptAsset.getOwnedEntities

getTypeName

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

isOfType

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

isSame

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

isScriptInputHidden

isScriptInputHidden(inputName: string): boolean
Beta
Returns true if the script inpput is hidden from the scene.
Parameters
- inputName: string
Returns boolean
Inherited from ScriptAsset.isScriptInputHidden

remapReferences

remapReferences(referenceMapping: object): 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 ScriptAsset.remapReferences

setScriptInputHidden

setScriptInputHidden(inputName: string, hidden: boolean): void
Beta
Used when you'd like to hide inputs from users in the scene.
Parameters
- inputName: string
- hidden: boolean
Returns void
Inherited from ScriptAsset.setScriptInputHidden