Class Cursor

Index

Constructors

Properties

faceDirection isVisible maxViewBlockDistance

Methods

getDefaultProperties getPosition getProperties getRay hide moveBy popPropertiesById pushPropertiesById resetToDefaultState setProperties show updatePropertiesById

Constructors

`Private`constructor

new Cursor(): Cursor
Returns Cursor

Properties

`Readonly`faceDirection

faceDirection: number

Throws

This property can throw errors.

World Ready

This property can't be read in early-execution mode.

`Readonly`isVisible

isVisible: boolean

Throws

This property can throw errors.

World Ready

This property can't be read in early-execution mode.

`Readonly`maxViewBlockDistance

maxViewBlockDistance: number

Throws

This property can throw errors.

World Ready

This property can't be read in early-execution mode.

Methods

getDefaultProperties

getDefaultProperties(): CursorProperties
Returns CursorProperties
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

getPosition

getPosition(): Vector3
Returns Vector3
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

getProperties

getProperties(): CursorProperties
Returns CursorProperties
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

getRay

getRay(): CursorRay
Returns CursorRay
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

hide

hide(): void
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

moveBy

moveBy(offset: Vector3): Vector3
Parameters
- offset: Vector3
Returns Vector3
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

popPropertiesById

popPropertiesById(identifier: string): void
Parameters
- identifier: string
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

pushPropertiesById

pushPropertiesById(properties: CursorProperties, identifier: string): void
Parameters
- properties: CursorProperties
- identifier: string
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

resetToDefaultState

resetToDefaultState(): void
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

setProperties

setProperties(properties: CursorProperties): void
Parameters
- properties: CursorProperties
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

show

show(): void
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

updatePropertiesById

updatePropertiesById(properties: CursorProperties, identifier?: string): void
Parameters
- properties: CursorProperties
- Optionalidentifier: string
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.