Class NafMessageBuilder

Builder for constructing NAF messages with a fluent API

Constructors

constructor

new NafMessageBuilder(): NafMessageBuilder
Returns NafMessageBuilder
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:84

Methods

build

build(): NafMessage
Build the NAF message

Returns NafMessage
NAF message based on the dataType
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:241

withAvatar

withAvatar(config: NafAvatarConfig): this
Set avatar component
Parameters
- config: NafAvatarConfig
Returns this
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:144

withBodyRotation

withBodyRotation(rotation: { x: number; y: number; z: number }): this
Set body rotation (euler angles)
Parameters
- rotation: { x: number; y: number; z: number }
Returns this
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:148

withCreator

withCreator(creator: string): this
Set creator
Parameters
- creator: string
Returns this
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:100

withCustomComponent

withCustomComponent(componentId: string, value: unknown): this
Set custom component by ID Use this for components not covered by specific methods
Parameters
- componentId: string
- value: unknown
Returns this
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:236

withDataType

withDataType(type: NafDataType): this
Set the data type
Parameters
- type: NafDataType
Returns this
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:88

withFaceSnapshot

withFaceSnapshot(data: unknown): this
Set face snapshot data
Parameters
- data: unknown
Returns this
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:223

withFaceSnapshotEnabled

withFaceSnapshotEnabled(enabled: boolean): this
Set face snapshot enabled
Parameters
- enabled: boolean
Returns this
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:219

withFirstSync

withFirstSync(isFirstSync: boolean): this
Set first sync flag (for new users)
Parameters
- isFirstSync: boolean
Returns this
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:116

withHandRaised

withHandRaised(raised: boolean): this
Set hand raised state
Parameters
- raised: boolean
Returns this
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:199

withHeadRotation

withHeadRotation(rotation: { w: number; x: number; y: number; z: number }): this
Set head rotation (quaternion)
Parameters
- rotation: { w: number; x: number; y: number; z: number }
Returns this
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:156

withLastOwnerTime

withLastOwnerTime(time?: number): this
Set last owner time
Parameters
- Optionaltime: number
Returns this
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:104

withLeftHandPosition

withLeftHandPosition(position: { x: number; y: number; z: number }): this
Set left hand position
Parameters
- position: { x: number; y: number; z: number }
Returns this
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:183

withLeftHandRotation

withLeftHandRotation(
rotation: { w: number; x: number; y: number; z: number },
): this
Set left hand rotation (quaternion)
Parameters
- rotation: { w: number; x: number; y: number; z: number }
Returns this
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:165

withMegaphone

withMegaphone(enabled: boolean): this
Set megaphone state
Parameters
- enabled: boolean
Returns this
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:227

withNetworkId

withNetworkId(id: string): this
Set network ID
Parameters
- id: string
Returns this
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:92

withOwner

withOwner(owner: string): this
Set owner
Parameters
- owner: string
Returns this
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:96

withPersistent

withPersistent(persistent: boolean): this
Set persistent flag
Parameters
- persistent: boolean
Returns this
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:112

withPinPosition

withPinPosition(position: { x: number; y: number; z: number }): this
Set pin position
Parameters
- position: { x: number; y: number; z: number }
Returns this
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:203

withPinScale

withPinScale(scale: { x: number; y: number; z: number }): this
Set pin scale
Parameters
- scale: { x: number; y: number; z: number }
Returns this
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:211

withPosition

withPosition(position: { x: number; y: number; z: number }): this
Set position component
Parameters
- position: { x: number; y: number; z: number }
Returns this
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:120

withRightHandPosition

withRightHandPosition(position: { x: number; y: number; z: number }): this
Set right hand position
Parameters
- position: { x: number; y: number; z: number }
Returns this
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:191

withRightHandRotation

withRightHandRotation(
rotation: { w: number; x: number; y: number; z: number },
): this
Set right hand rotation (quaternion)
Parameters
- rotation: { w: number; x: number; y: number; z: number }
Returns this
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:174

withScale

withScale(scale: { x: number; y: number; z: number }): this
Set scale component
Parameters
- scale: { x: number; y: number; z: number }
Returns this
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:136

withTemplate

withTemplate(template: string): this
Set template
Parameters
- template: string
Returns this
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:108

withTemporaryMegaphone

withTemporaryMegaphone(enabled: boolean): this
Set temporary megaphone state
Parameters
- enabled: boolean
Returns this
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:231

withVelocity

withVelocity(velocity: { x: number; y: number; z: number }): this
Set velocity component
Parameters
- velocity: { x: number; y: number; z: number }
Returns this
- Defined in packages/core/dist/builders/NafMessageBuilder.d.ts:128