Class WidgetComponentRenderPrimitive

Hierarchy (View Summary)

WidgetComponentBase
- WidgetComponentRenderPrimitive

Index

Properties

componentType location lockToSurface name offset primitiveType valid visible widget

Methods

delete setPrimitive

Properties

`Readonly`componentType

componentType: WidgetComponentType

Throws

InvalidWidgetComponentError

`Readonly`location

location: Vector3

Throws

InvalidWidgetComponentError

`World mutation`lockToSurface

lockToSurface: boolean

Remarks

`Readonly`name

name: string

Throws

InvalidWidgetComponentError

`World mutation`offset

offset: Vector3

Remarks

`Readonly`primitiveType

primitiveType: PrimitiveType

Throws

InvalidWidgetComponentError

Throws

InvalidWidgetError

`Readonly`valid

valid: boolean

visible

visible: boolean

`Readonly`widget

widget: Widget

Throws

InvalidWidgetComponentError

Methods

delete

delete(): void
World mutation
Returns void

Remarks

Throws
InvalidWidgetComponentError
Inherited from WidgetComponentBase.delete
- Defined in @minecraft/server-editor.d.ts:5648

setPrimitive

setPrimitive(
    primitive:
        | WidgetComponentRenderPrimitiveTypeAxialSphere
        | WidgetComponentRenderPrimitiveTypeBox
        | WidgetComponentRenderPrimitiveTypeCone
        | WidgetComponentRenderPrimitiveTypeCuboid
        | WidgetComponentRenderPrimitiveTypeCylinder
        | WidgetComponentRenderPrimitiveTypeDisc
        | WidgetComponentRenderPrimitiveTypeEllipsoid
        | WidgetComponentRenderPrimitiveTypeLine
        | WidgetComponentRenderPrimitiveTypePyramid
        | WidgetComponentRenderPrimitiveTypeWireframeMesh,
): void
World mutation
Parameters
- primitive:
      | WidgetComponentRenderPrimitiveTypeAxialSphere
      | WidgetComponentRenderPrimitiveTypeBox
      | WidgetComponentRenderPrimitiveTypeCone
      | WidgetComponentRenderPrimitiveTypeCuboid
      | WidgetComponentRenderPrimitiveTypeCylinder
      | WidgetComponentRenderPrimitiveTypeDisc
      | WidgetComponentRenderPrimitiveTypeEllipsoid
      | WidgetComponentRenderPrimitiveTypeLine
      | WidgetComponentRenderPrimitiveTypePyramid
      | WidgetComponentRenderPrimitiveTypeWireframeMesh
Returns void

Remarks

Throws
InvalidWidgetComponentError

Throws
InvalidWidgetError
- Defined in @minecraft/server-editor.d.ts:5926