Class Avatar

constructor

• new Avatar(): Avatar

• Returns Avatar

_actorId

Optional _avatarAssetId

_avatarType

Optional _faceToSpy

Optional _options

_outerSyncData

Optional _rotateSpy

_uuid

alongMainAvatar

fromPreCreate

syncFlag

allPendantsVisibility

• set allPendantsVisibility(show): void

• 设置是否显示所有挂件

  Parameters

  • show: boolean

    true显示 false隐藏

  Returns void

isSelf

• get isSelf(): boolean

• Returns boolean

status

• get status(): IAvatarStatus

• Returns IAvatarStatus

syncInfo

• get syncInfo(): string

• 获取开发者设置的当前的同步数据

  Returns string

syncPriority

• get syncPriority(): number

• 获取同步优先级

  Returns number

userId

• get userId(): string

• 获取userId

  Returns string

_beCloned

• _beCloned(params?): void

• Parameters

  • Optional params: ISpawnParameters

  Returns void

_handleMovingSpy

• _handleMovingSpy(isMoving, isRotating): void

• Parameters

  • isMoving: boolean

  • isRotating: boolean

  Returns void

_setCurrentPath

• _setCurrentPath(pathConfig?): void

• 设置 Avatar 当前的 pathConfig

  Parameters

  • Optional pathConfig: IPathConfig

  Returns void

_setUserId

• _setUserId(val): void

• 覆盖 userId，谨慎调用

  Parameters

  • val: string

  Returns void

_stopVbrMovingStateAndSpy

• _stopVbrMovingStateAndSpy(user): void

• 软解v1使用 vbr下人物停止运动依赖dc设置

  Parameters

  • user: IUserState

  Returns void

_updateMovingState

• _updateMovingState(isMoving): void

• Parameters

  • isMoving: boolean

  Returns void

_updateTransform

• _updateTransform(position, rotation): void

• Parameters

  • position: IPoint

  • rotation: IRotation

  Returns void

addPendant

• addPendant(path): Promise<any>

• 添加挂件

  Parameters

  • path: string | string[]

    挂件资产路径, 可以是数组批量添加

  Returns Promise<any>

  Throws

  资源加载失败

aiSay

• aiSay(text): Promise<void>

• 角色说出传入的文本

  Parameters

  • text: string

  Returns Promise<void>

aiSayPause

• aiSayPause(): void

• 角色暂停说话

  Returns void

aiSayResume

• aiSayResume(): void

• 角色重启说话

  Returns void

aiSayStop

• aiSayStop(): void

• 角色暂停说话

  Returns void

changeComponents

• changeComponents(component, needSync?): Promise<void>

• 换装

  Parameters

  • component: IAvatarComponent | IAvatarComponent[]

    单个或多个换装部件

  • needSync: boolean = true

  Returns Promise<void>

  Throws

  100001-套装和单件一起传入 4005-传入值无效 4006-卸载失败

changeSkinColor

• changeSkinColor(type?, colors?): void

• 用于给主角的皮肤换色，央视非洲业务 type: 默认为0默认颜色(最白)，1为黄色，2为黑色

  Parameters

  • type: EAvatarSkinType = EAvatarSkinType.White

  • Optional colors: number[]

  Returns void

conductToPoint

• conductToPoint(options): Promise<void>

• Parameters

  • options: IConductToOptions

  Returns Promise<void>

deleteComponent

• deleteComponent(component): void

• 删除装扮

  Parameters

  • component: IAvatarComponent

    待删除的部件

  Returns void

  Throws

  4006-卸载失败

dispose

• dispose(needSync?): void

• 销毁 Avatar

  Parameters

  • needSync: boolean = true

  Returns void

diyFace

• diyFace(type, value): void

• 捏脸

  Parameters

  • type: string

  • value: number

  Returns void

  Throws

  7005: 传入的捏脸维度错误

faceTo

• faceTo(targetYaw, startFrom?, time?, endCallback?): undefined | Promise<unknown>

• 角色插值旋转到指定方向，镜头不动

  Parameters

  • targetYaw: number

    目标角度的yaw值(只允许转yaw)

  • Optional startFrom: IRotation

    起始点，默认为当前位置，可不传

  • time: number = 1000

    用时 默认1s

  • Optional endCallback: (() => void)

    • • (): void

      • Returns void

  Returns undefined | Promise<unknown>

faceToCamera

• faceToCamera(options?): void

• 角色面向镜头

  Parameters

  • Optional options: {
        endCallback?: (() => void);
        time?: number;
    }

    • Optional endCallback?: (() => void)

      • • (): void

        • Returns void

    • Optional time?: number

  Returns void

fromSync

• fromSync(): boolean

• 是否属于同步角色(包含robot)

  Returns boolean

generateUuid

• generateUuid(option?): string

• Parameters

  • Optional option: any

  Returns string

getAllPendants

• getAllPendants(): XActor<IActorEvents>[]

• 获取所有挂件

  Returns XActor<IActorEvents>[]

getCurrentComponents

• getCurrentComponents(): IAvatarComponent[]

• 获取当前装扮

  Returns IAvatarComponent[]

getCurrentPendents

• getCurrentPendents(): string[]

• 获取当前挂件

  Returns string[]

getNickName

• getNickName(): string

• 获取角色昵称

  Returns string

  角色昵称，没有调用setNickName之前返回空

getQuickShot

• getQuickShot(animId, option, onBeforeShot?): Promise<string>

• 获取角色的快照

  Parameters

  • animId: string

    播放动画的id(会拍播放该动作时的快照)

  • option: QuickShotOption

  • Optional onBeforeShot: (() => void)

    可选，拍摄前执行

    • • (): void

      • Returns void

  Returns Promise<string>

  图片的base64 str，拍摄失败则为空

getWorld

• getWorld(): World

• Returns World

hasMoveAnimation

• hasMoveAnimation(): undefined | string

• 是否设置了move animation

  Returns undefined | string

hide

• hide(): void

• 隐藏角色

  Returns void

hideNickName

• hideNickName(val): void

• 隐藏角色昵称

  Parameters

  • val: boolean

    是否隐藏

  Returns void

init

• init(options?): Promise<void>

• Parameters

  • Optional options: any

  Returns Promise<void>

initAISay

• initAISay(data): void

• 赋予角色说话的能力

  Parameters

  • data: IInitAISay

  Returns void

isRobot

• isRobot(): boolean

• Returns boolean

lookAt

• lookAt(target, options?): Promise<void>

• Avatar和镜头一齐转向指定位置，仅 主角 可调用

  Parameters

  • target: number | IPoint

  • Optional options: ILookAtOptions

    选项，查看 ILookAtOptions 定义

  Returns Promise<void>

moveTo

• moveTo(start, end, inter?, callback?): boolean

• 同步其他玩家移动状态

  Parameters

  • start: IPoint

  • end: IPoint

  • Optional inter: IPoint[]

  • Optional callback: (() => void)

    • • (): void

      • Returns void

  Returns boolean

navigateTo

• navigateTo(point, options?): undefined | Promise<void>

• 自动寻路到某一个点，仅 主角 可调用

  Parameters

  • point: IPoint

  • Optional options: INavigateToOptions

    选项，查看 INavigateToOptions 定义

  Returns undefined | Promise<void>

nickNameIsHidden

• nickNameIsHidden(): any

• 获取角色昵称的显隐状态

  Returns any

onDispose

• onDispose(): void

• Returns void

onLoad

• onLoad(): void

• Returns void

onLookAtEnd

• onLookAtEnd(event): void

• Parameters

  • event: IRotateEndEvent

  Returns void

onNavToEnd

• onNavToEnd(event): void

• Parameters

  • event: IMoveEndEvent

  Returns void

onReceiveSyncInfo

• onReceiveSyncInfo(event): void

• LifeCyles

  Parameters

  • event: IReceiveSyncInfoEvent

  Returns void

playAnimation

• playAnimation(path, isLoop?, callback?): Promise<void>

• 播放动作

  Parameters

  • path: string

    动作资产路径

  • Optional isLoop: boolean

  • Optional callback: ((...args) => any)

    • • (...args): any

      • Parameters

        • Rest ...args: any

        Returns any

  Returns Promise<void>

removePendant

• removePendant(path): void

• 移除挂件

  Parameters

  • path: string | string[]

    挂件资产路径

  Returns void

  Throws

  4006卸载失败

setAiSayVolume

• setAiSayVolume(volume): void

• 设置角色说话的音量

  Parameters

  • volume: number

  Returns void

  Description

  0~1的小数，以初始化的音量为基数

setAnimationInstanceBinding

• setAnimationInstanceBinding(bindings, needSync?): void

• 设置动画

  Parameters

  • bindings: ISkeletonAnimationBinding[]

  • needSync: boolean = true

    设置是否发送同步消息

  Returns void

setExtraInfo

• setExtraInfo(avatarAssetId): Promise<void>

• 设置引擎extraInfo

  Parameters

  • avatarAssetId: string

    角色资产id

  Returns Promise<void>

setMaxDecreaseAcceleration

• setMaxDecreaseAcceleration(acceleration): void

• 设置减速时最大加速度，浮点数，默认值为1000，范围为1-1000

  Parameters

  • acceleration: number

  Returns void

setMaxIncreaseAcceleration

• setMaxIncreaseAcceleration(acceleration): void

• 设置加速时最大加速度，浮点数，默认值为1，范围为1-1000

  Parameters

  • acceleration: number

  Returns void

setNickName

• setNickName(texts, options?, needSync?): void

• 设置昵称

  Parameters

  • texts: string

  • Optional options: INickNameOptions

  • needSync: boolean = true

  Returns void

  Throws

  当字符长度超过18,将会报错

setPendantVisibility

• setPendantVisibility(path, show): void

• 设置挂件可见性

  Parameters

  • path: string

    要隐藏的挂件path

  • show: boolean

    true显示 false隐藏

  Returns void

setPictureBeforeNickName

• setPictureBeforeNickName(url, needSync?): Promise<void>

• 当传入的url为undefined或null时,前置图片隐藏 需要在avatar init之后调用

  Parameters

  • url: undefined | string

    图片url

  • needSync: boolean = true

  Returns Promise<void>

setPriority

• setPriority(priority): void

• Parameters

  • priority: number

  Returns void

setScaling

• setScaling(scaling): void

• 设置缩放

  Parameters

  • scaling: IScaling

  Returns void

setSkeleton

• setSkeleton(path, needSync?): void

• 设置骨骼信息

  Parameters

  • path: string

    骨骼资产path

  • needSync: boolean = true

    设置是否发送同步消息

  Returns void

setSkeletonAnimation

• setSkeletonAnimation(skeletonOption, needSync?): void

• 设置角色骨骼和动画相关资产

  Parameters

  • skeletonOption: ISkeletonOptions

  • needSync: boolean = true

  Returns void

setSyncInfo

• setSyncInfo(info): Promise<unknown>

• 设置同步信息

  Parameters

  • info: string

  Returns Promise<unknown>

setSyncPriority

• setSyncPriority(syncPriority): void

• 设置同步优先级信息，默认为0 0: 默认情况下为0即可 -1: 代表不同步给其他人 999: 最高优先级同步，如主播或老板需设置为999 正常使用默认优先级即可

  Parameters

  • syncPriority: number

  Returns void

  Throws

  ParamError

setUuid

• setUuid(id): void

• Parameters

  • id: string

  Returns void

setVAT

• setVAT(path, needSync?): void

• 设置 VAT

  Parameters

  • path: string

  • needSync: boolean = true

    设置是否发送同步消息

  Returns void

setVatAnimationInstanceBinding

• setVatAnimationInstanceBinding(bindings, needSync?): void

• 设置 VAT 的动画状态机

  Parameters

  • bindings: IVATAnimationBinding[]

  • needSync: boolean = true

    设置是否发送同步消息

  Returns void

show

• show(): void

• 显示角色

  Returns void

stopMove

• stopMove(): void

• 打断当前在执行的导航、转向、带览操作 仅主角可调用

  Returns void