Class WidgetComponentGizmo

Hierarchy (View Summary)

WidgetComponentBase
- WidgetComponentGizmo

Index

Properties

activated componentType enabledAxes location lockToSurface name normalizedOffsetOverride? offset scaleMode screenScale valid visible widget worldScale

Methods

delete setStateChangeEvent

Properties

activated

activated: boolean

`Readonly`componentType

componentType: WidgetComponentType

Throws

This property can throw when used.

InvalidWidgetComponentError

`World mutation`enabledAxes

enabledAxes: Axis

Remarks

`Readonly`location

location: Vector3

Throws

This property can throw when used.

InvalidWidgetComponentError

`World mutation`lockToSurface

lockToSurface: boolean

Remarks

`Readonly`name

name: string

Throws

This property can throw when used.

InvalidWidgetComponentError

`Optional` `World mutation`normalizedOffsetOverride

normalizedOffsetOverride?: Vector3

Remarks

`World mutation`offset

offset: Vector3

Remarks

`World mutation`scaleMode

scaleMode: WidgetGizmoScaleMode

Remarks

`World mutation`screenScale

screenScale: number

Remarks

`Readonly`valid

valid: boolean

visible

visible: boolean

`Readonly`widget

widget: Widget

Throws

This property can throw when used.

InvalidWidgetComponentError

`World mutation`worldScale

worldScale: number

Remarks

Methods

delete

delete(): void
World mutation
Returns void
Remarks
Throws
This function can throw errors.

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

setStateChangeEvent

setStateChangeEvent(
    eventFunction?: (
        arg0: WidgetComponentGizmoStateChangeEventParameters,
    ) => void,
): void
World mutation
Parameters
- OptionaleventFunction: (arg0: WidgetComponentGizmoStateChangeEventParameters) => void
Returns void
Remarks
Throws
This function can throw errors.

InvalidWidgetComponentError
- Defined in @minecraft/server-editor.d.ts:5368