Class RenderComponentElement

Represents a render component in the PlayCanvas engine.

Hierarchy (view full)

ComponentElement
- RenderComponentElement

Index

Accessors

castShadows component enabled material receiveShadows type

Accessors

castShadows

get castShadows(): boolean
Gets the cast shadows flag of the render component.

Returns boolean
The cast shadows flag.
- Defined in submodules/web-components/src/components/render-component.ts:80
set castShadows(value): void
Sets the cast shadows flag of the render component.
Parameters
- value: boolean
  The cast shadows flag.
Returns void
- Defined in submodules/web-components/src/components/render-component.ts:69

component

get component(): RenderComponent
Gets the render component.

Returns RenderComponent
The render component.
Overrides ComponentElement.component
- Defined in submodules/web-components/src/components/render-component.ts:42

enabled

get enabled(): boolean
Gets the enabled state of the component.

Returns boolean
The enabled state of the component.
Inherited from ComponentElement.enabled
- Defined in submodules/web-components/src/components/component.ts:89
set enabled(value): void
Sets the enabled state of the component.
Parameters
- value: boolean
  The enabled state of the component.
Returns void
Inherited from ComponentElement.enabled
- Defined in submodules/web-components/src/components/component.ts:78

material

get material(): string
Gets the id of the material asset used by the render component.

Returns string
The id of the material asset.
- Defined in submodules/web-components/src/components/render-component.ts:99
set material(value): void
Sets the material of the render component.
Parameters
- value: string
  The id of the material asset to use.
Returns void
- Defined in submodules/web-components/src/components/render-component.ts:88

receiveShadows

get receiveShadows(): boolean
Gets the receive shadows flag of the render component.

Returns boolean
The receive shadows flag.
- Defined in submodules/web-components/src/components/render-component.ts:118
set receiveShadows(value): void
Sets the receive shadows flag of the render component.
Parameters
- value: boolean
  The receive shadows flag.
Returns void
- Defined in submodules/web-components/src/components/render-component.ts:107

type

get type():
    | "asset"
    | "box"
    | "plane"
    | "sphere"
    | "capsule"
    | "cylinder"
    | "cone"
Gets the type of the render component.

Returns
    | "asset"
    | "box"
    | "plane"
    | "sphere"
    | "capsule"
    | "cylinder"
    | "cone"
The type.
- Defined in submodules/web-components/src/components/render-component.ts:61
set type(value): void
Sets the type of the render component.
Parameters
- value:
      | "asset"
      | "box"
      | "plane"
      | "sphere"
      | "capsule"
      | "cylinder"
      | "cone"
  The type.
Returns void
- Defined in submodules/web-components/src/components/render-component.ts:50