For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /server-editor/classes/GuidePlaneManager.md.

Class: GuidePlaneManager experimental

Beta

Properties

allPlanesVisible

allPlanesVisible: boolean

World Mutation Beta

Remarks

Methods

addPlane()

addPlane(origin, normal, visible, outlineColor, fillColor): string

World Mutation Beta

Parameters

origin

Vector3

normal

Vector3

visible

boolean

outlineColor

RGBA

fillColor

RGBA

Returns

string

Remarks

Throws

This function can throw errors.


getPlane()

getPlane(planeId): GuidePlane | undefined

World Mutation Beta

Parameters

planeId

string

Returns

GuidePlane | undefined

Remarks

Throws

This function can throw errors.


getPlanes()

getPlanes(): GuidePlane[]

World Mutation Beta

Returns

GuidePlane[]

Remarks

Throws

This function can throw errors.


removePlane()

removePlane(planeId): void

World Mutation Beta

Parameters

planeId

string

Returns

void

Remarks

Throws

This function can throw errors.


setPlaneColors()

setPlaneColors(planeId, outlineColor, fillColor): void

World Mutation Beta

Parameters

planeId

string

outlineColor

RGBA

fillColor

RGBA

Returns

void

Remarks

Throws

This function can throw errors.


setPlaneNormal()

setPlaneNormal(planeId, normal): void

World Mutation Beta

Parameters

planeId

string

normal

Vector3

Returns

void

Remarks

Throws

This function can throw errors.


setPlaneOrigin()

setPlaneOrigin(planeId, origin): void

World Mutation Beta

Parameters

planeId

string

origin

Vector3

Returns

void

Remarks

Throws

This function can throw errors.


setPlaneVisibility()

setPlaneVisibility(planeId, visible): void

World Mutation Beta

Parameters

planeId

string

visible

boolean

Returns

void

Remarks

Throws

This function can throw errors.