Class Component

Example

You can add a component to an object by selecting an object in the Scene Hierarchy panel, and pressing + Add Component in the Inspector panel; or through script:

const currentObject =  script.sceneObject;
const newImageComponent = currentObject.createComponent("Component.Image");
Copy

You can access components on an object directyly through script:

const currentObject =  script.sceneObject;
const firstImageOnObject = currentObject.getComponent("Component.Image");
Copy

or creating an input for it:

// @input Component.image passedInComponent
const imageComponent = script.passedInComponent;
Copy

Component classes can be a child of other classes. For example, you can get a ClothVisual and EyeColorVisual by asking for the parent MaterialMeshVisual.

// Get the first MaterialMeshVisual on the object
const someMaterialMeshVissual = currentObject.getComponent("Component.MaterialMeshVisual");

// Confirm the type of visual that is needed
if(someMaterialMeshVissual.isOfType("Component.ClothVisual")){
    var mat = someMaterialMeshVissual.mainMaterial;
}
Copy

You can also write these scripts as TypeScript. Learn more in the TypeScript guide.

@component
export class somethingWithImage extends BaseScriptComponent {
  @input
  imageComponent: Component.Image;

  onAwake() {
    let imageComponent = this.imageComponent;
  }
}
Copy