Editor.Components.CompositionLayerRenderComponent
ClassBase class for components attached to scene objects.
Index
Properties
Methods
Example
const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
const scene = model.project.scene;
// Create a scene object and add a component by type string
const obj = scene.createSceneObject('CompDemo');
const cam = obj.addComponent('Camera') as Editor.Components.Component;
// Component base class: enabled, name, sceneObject
console.log(`Component: type=${cam.getTypeName()}, enabled=${cam.enabled}`);
console.log(` sceneObject: "${cam.sceneObject.name}"`);
// Toggle enabled state
cam.enabled = false;
console.log(`Disabled: enabled=${cam.enabled}`);
cam.enabled = true;
console.log(`Re-enabled: enabled=${cam.enabled}`);
Extends
Properties
adaptiveResolutionEnabled
adaptiveResolutionEnabled:
boolean
adaptiveResolutionRoundingMultiple
adaptiveResolutionRoundingMultiple:
number
adaptiveResolutionScaler
adaptiveResolutionScaler:
number
enabled
enabled:
boolean
Whether the component is active.
Inherited from
hasPrefabChanges
readonlyhasPrefabChanges:boolean
Whether this entity differs from its counterpart in the prefab or was added to the prefab instance. Always false outside prefab instances.
Inherited from
id
readonlyid:Uuid
The unique id of the entity.
Inherited from
isPrefabInstanceRoot
readonlyisPrefabInstanceRoot:boolean
Whether this entity is the root of a prefab instance.
Inherited from
Component.isPrefabInstanceRoot
meta
readonlymeta:Meta
Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.
Inherited from
name
name:
string
Name of the component.
Inherited from
sceneObject
readonlysceneObject:SceneObject
Scene object this component is attached to.
Inherited from
type
readonlytype:string
The entity's type.
Inherited from
updateModes
updateModes:
CompositionLayerRenderUpdateMode[]
Methods
getDirectlyReferencedEntities()
getDirectlyReferencedEntities():
Entity[]
A list of entities which this entity has a reference to.
Returns
Entity[]
Inherited from
Component.getDirectlyReferencedEntities
getMeta()
staticgetMeta():Meta
Returns metadata about this type.
Returns
Overrides
getOwnedEntities()
getOwnedEntities():
Entity[]
A list of entities which has a reference to this entity.
Returns
Entity[]
Inherited from
getPrefabInstanceRoot()
getPrefabInstanceRoot():
Prefabable
Returns the nearest prefab instance root that contains this entity, starting with the entity itself, or null if it is not part of a prefab instance.
Returns
Inherited from
Component.getPrefabInstanceRoot
getTypeName()
staticgetTypeName():string
Returns the type name of this class.
Returns
string
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object is of the specified type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object refers to the same instance as the given object.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean