类Roaming ​

漫游。

属性 ​

points ​

获取或设置路径点集合。 Point3D 数组类型。

pause ​

获取或设置暂停。 boolean 类型。

pathVisible ​

获取或设置路径可见性。 boolean 类型。

executing ​

获取是否正在执行漫游。 boolean 类型。

speed ​

获取或设置角色移动速度，默认值为1。 number 类型。

offsetY ​

获取或设置垂直偏移量，默认值为0。 number 类型。

方法 ​

on ​

on(
    type: string,
    callback: (ev: EventArg) => void
    ): string

监听事件。

返回事件唯一编号。 string 类型。

参数

• type ： string

事件类型。 string 类型。详情查看本节 事件 详细介绍。

• callback ： (ev: EventArg) => void

回调函数。 (ev: EventArg) => void 类型。

off ​

off(id: string): void;

移除指定编号的事件。

返回 void 类型。

参数

• id ： string

事件唯一编号。 string 类型。

startPathEdit ​

startPathEdit(): void;

开始路径编辑。

返回 void 类型。

无参数。

endPathEdit ​

async endPathEdit(): Promise<void>;

结束路径编辑，异步方法。

异步返回 void 类型。

无参数。

buildPath ​

buildPath(): void;

创建路径。

返回 void 类型。

无参数。

startToRoam ​

async startToRoam(person: boolean): Promise<void>;

开始漫游，异步方法。

异步返回 void 类型。

参数

• person ： boolean 类型

人称， true 表示第一人称， false 表示第三人称。

endToRoam ​

endToRoam(): void;

结束漫游。

返回 void 类型。

无参数。

事件 ​

EVENT_PAUSE ​

暂停事件。

EVENT_CONTINUE ​

继续事件。

EVENT_ARRIVE ​

到达事件（终点）。

EVENT_ENDPATHEDIT ​

路径编辑结束事件。

EVENT_POINTCLICK ​

路径点点击事件。