API
Return to top
NavLink
编辑

玩法 / NavLink

NavLink Class
​

寻路链接

寻路链接能将导航网格体内没有直接路径的区域链接起来

如何使用寻路链接：

  • 创建一个寻路链接对象。可手动将左侧栏中逻辑对象中的寻路链接拖入场景中，在编辑器属性面板中调整参数；也可以在脚本中动态创建寻路链接。

  • 设置寻路链接对象属性 左点右点位置分别表示链接在寻路区域中的两个点，链接建立后AI会从一个点沿直线前往另一个点

  • 需要注意的是，链接并不保证指定线路的“可到达性”，即如果链接线上存在AI无法跨越或者无法行走的区域，寻路有可能失效

使用示例:创建一个名为"NavLinkSample"的脚本，复制以下代码后将脚本挂载于地板上，接着在场景中拖入一个寻路区域，相对位置设置为(1200, 0, 0)，相对缩放设置为(20, 20, 10)，再开启世界设置中的 动态构建寻路导航数据

进入游戏后，按 N 控制NPC开始寻路；按 R 重置NPC位置；按 1 切换寻路链接的区域类型；按 2 切换寻路链接的连通方式。可以测试NPC在不同情景下的寻路表现。 代码如下：

ts
@Component
export default class NavLinkSample extends Script {
    platform1 = null as Model;
    platform2 = null as Model;
    bridge = null as Model;
    target = null as Model;
    npc = null as Character;
    navLink = null as NavLink;

    // 当脚本被实例后，会在第一帧更新前调用此函数
    protected onStart(): void {
        if (SystemUtil.isServer()) {
            // 创建平台1
            this.platform1 = GameObject.spawn("197386", {
                replicates: true,
                transform: new Transform(new Vector(2000, 0, 0), new Rotation(0, 0, 0), new Vector(4, 20, 1))
            });

            // 创建平台2
            this.platform1 = GameObject.spawn("197386", {
                replicates: true,
                transform: new Transform(new Vector(700, 0, 0), new Rotation(0, 0, 0), new Vector(10, 20, 1))
            });

            // 创建连接桥
            this.platform1 = GameObject.spawn("197386", {
                replicates: true,
                transform: new Transform(new Vector(1500, 600, 80), new Rotation(0, 0, 0), new Vector(6, 0.5, 0.2))
            });

            // 创建目标点
            this.target = GameObject.spawn("197388", {
                replicates: true,
                transform: new Transform(new Vector(500, -500, 100), new Rotation(0, 0, 0), new Vector(1, 1, 1))
            });
            // 关闭目标点碰撞
            setTimeout(() => {
                this.target.collisionEnabled = false;
            }, 2000);

            // 创建寻路链接
            this.navLink = GameObject.spawn("NavigationLink", {
                replicates: true,
                transform: new Transform(new Vector(1500, 600, 100), new Rotation(0, 0, 0), new Vector(1, 1, 1))
            });
            // 设置寻路链接
            setTimeout(() => {
                this.navLink.leftPosition = new Vector(400, 0, 0);
                this.navLink.rightPosition = new Vector(-400, 0, 0);
                this.navLink.navLinkArea = LinkClassType.Default;
                this.navLink.direction = DirectionType.BothWays;
            }, 2000);

            // 创建npc
            this.npc = GameObject.spawn("Character", {
                replicates: true,
                transform: new Transform(new Vector(2000, -600, 500), new Rotation(0, 0, 0), new Vector(1, 1, 1))
            });

            // 接收 npc向target寻路 事件，执行逻辑
            Event.addClientListener("NPCNavigateToTarget", ()=>{
                Navigation.navigateTo(this.npc, this.target.worldTransform.position);
            });

            // 接收 重置npc位置 事件，执行逻辑
            Event.addClientListener("ResetNPC", ()=>{
                this.npc.worldTransform.position = new Vector(2000, -600, 500);
            });

            // 接收 切换寻路链接区域类型 事件（ Default 与 Null 切换）
            Event.addClientListener("SwitchLinkClassType", ()=>{
                if (this.navLink.navLinkArea == LinkClassType.Default) {
                    this.navLink.navLinkArea = LinkClassType.Null;
                } else {
                    this.navLink.navLinkArea = LinkClassType.Default;
                }
            });

            // 接收 切换寻路链接通行方向 事件（ Bothways 与 RightToLeft 切换）
            Event.addClientListener("SwitchDirectionType", ()=>{
                if (this.navLink.direction == DirectionType.BothWays) {
                    this.navLink.direction = DirectionType.RightToLeft;
                } else {
                    this.navLink.direction = DirectionType.BothWays;
                }
            });
        }

        if (SystemUtil.isClient()) {
            // 按 N 发送 npc向target寻路 事件
            InputUtil.onKeyDown(Keys.N, ()=>{
                Event.dispatchToServer("NPCNavigateToTarget");
            });

            // 按 R 发送 重置npc位置 事件
            InputUtil.onKeyDown(Keys.R, ()=>{
                Event.dispatchToServer("ResetNPC");
            });

            // 按 1 发送 切换寻路链接区域类型 事件（ Default 与 Null 切换）
            InputUtil.onKeyDown(Keys.One, ()=>{
                Event.dispatchToServer("SwitchLinkClassType");
            });

            // 按 2 发送 切换寻路链接通行方向 事件（ Bothways 与 RightToLeft 切换）
            InputUtil.onKeyDown(Keys.Two, ()=>{
                Event.dispatchToServer("SwitchDirectionType");
            });
        }
    }
}
@Component
export default class NavLinkSample extends Script {
    platform1 = null as Model;
    platform2 = null as Model;
    bridge = null as Model;
    target = null as Model;
    npc = null as Character;
    navLink = null as NavLink;

    // 当脚本被实例后，会在第一帧更新前调用此函数
    protected onStart(): void {
        if (SystemUtil.isServer()) {
            // 创建平台1
            this.platform1 = GameObject.spawn("197386", {
                replicates: true,
                transform: new Transform(new Vector(2000, 0, 0), new Rotation(0, 0, 0), new Vector(4, 20, 1))
            });

            // 创建平台2
            this.platform1 = GameObject.spawn("197386", {
                replicates: true,
                transform: new Transform(new Vector(700, 0, 0), new Rotation(0, 0, 0), new Vector(10, 20, 1))
            });

            // 创建连接桥
            this.platform1 = GameObject.spawn("197386", {
                replicates: true,
                transform: new Transform(new Vector(1500, 600, 80), new Rotation(0, 0, 0), new Vector(6, 0.5, 0.2))
            });

            // 创建目标点
            this.target = GameObject.spawn("197388", {
                replicates: true,
                transform: new Transform(new Vector(500, -500, 100), new Rotation(0, 0, 0), new Vector(1, 1, 1))
            });
            // 关闭目标点碰撞
            setTimeout(() => {
                this.target.collisionEnabled = false;
            }, 2000);

            // 创建寻路链接
            this.navLink = GameObject.spawn("NavigationLink", {
                replicates: true,
                transform: new Transform(new Vector(1500, 600, 100), new Rotation(0, 0, 0), new Vector(1, 1, 1))
            });
            // 设置寻路链接
            setTimeout(() => {
                this.navLink.leftPosition = new Vector(400, 0, 0);
                this.navLink.rightPosition = new Vector(-400, 0, 0);
                this.navLink.navLinkArea = LinkClassType.Default;
                this.navLink.direction = DirectionType.BothWays;
            }, 2000);

            // 创建npc
            this.npc = GameObject.spawn("Character", {
                replicates: true,
                transform: new Transform(new Vector(2000, -600, 500), new Rotation(0, 0, 0), new Vector(1, 1, 1))
            });

            // 接收 npc向target寻路 事件，执行逻辑
            Event.addClientListener("NPCNavigateToTarget", ()=>{
                Navigation.navigateTo(this.npc, this.target.worldTransform.position);
            });

            // 接收 重置npc位置 事件，执行逻辑
            Event.addClientListener("ResetNPC", ()=>{
                this.npc.worldTransform.position = new Vector(2000, -600, 500);
            });

            // 接收 切换寻路链接区域类型 事件（ Default 与 Null 切换）
            Event.addClientListener("SwitchLinkClassType", ()=>{
                if (this.navLink.navLinkArea == LinkClassType.Default) {
                    this.navLink.navLinkArea = LinkClassType.Null;
                } else {
                    this.navLink.navLinkArea = LinkClassType.Default;
                }
            });

            // 接收 切换寻路链接通行方向 事件（ Bothways 与 RightToLeft 切换）
            Event.addClientListener("SwitchDirectionType", ()=>{
                if (this.navLink.direction == DirectionType.BothWays) {
                    this.navLink.direction = DirectionType.RightToLeft;
                } else {
                    this.navLink.direction = DirectionType.BothWays;
                }
            });
        }

        if (SystemUtil.isClient()) {
            // 按 N 发送 npc向target寻路 事件
            InputUtil.onKeyDown(Keys.N, ()=>{
                Event.dispatchToServer("NPCNavigateToTarget");
            });

            // 按 R 发送 重置npc位置 事件
            InputUtil.onKeyDown(Keys.R, ()=>{
                Event.dispatchToServer("ResetNPC");
            });

            // 按 1 发送 切换寻路链接区域类型 事件（ Default 与 Null 切换）
            InputUtil.onKeyDown(Keys.One, ()=>{
                Event.dispatchToServer("SwitchLinkClassType");
            });

            // 按 2 发送 切换寻路链接通行方向 事件（ Bothways 与 RightToLeft 切换）
            InputUtil.onKeyDown(Keys.Two, ()=>{
                Event.dispatchToServer("SwitchDirectionType");
            });
        }
    }
}

Hierarchy ​

Table of contents ​

Properties
​

click

Properties
​

onBeforeDestroyDelegate: MulticastDelegate<() => void>
物体销毁前事件回调
onCustomPropertyChange: Readonly<MulticastDelegate<(path: string, value: unknown, oldValue: unknown) => void>> other
监听自定义属性同步事件
onDestroyDelegate: MulticastDelegate<() => void>
物体销毁后事件回调

Accessors
​

direction(): DirectionType
获取链接线的通行方向
leftPosition(): Vector
获取左点位置
navLinkArea(): LinkClassType
获取链接区域的寻路类型
rightPosition(): Vector
获取右点位置
click

Accessors
​

assetId(): string
获取当前物体使用资源的GUID
gameObjectId(): string
获取物体的唯一标识（唯一标识一个对象的字符串）。
isDestroyed(): boolean
当前物体是否被销毁
isReady(): boolean
当前物体状态
localTransform(): Transform
当前物体本地变换
name(): string
返回当前物体名称
netStatus(): NetStatus
获取当前物体同步状态
parent(): GameObject
获取当前父物体
prefabAssetId(): string
返回当前物体使用的预制体资源ID，如果当前物体不是预制体，则返回空
sceneCaptureTag(): string
获取当前物体的捕捉标签
tag(): string
获取当前物体的标签
worldTransform(): Transform
当前物体世界变换

Methods
​

click

Methods
​

addComponent<T: extends Script<T>>(constructor: (...args: unknown[]) => T: extends Script<T>, bInReplicates?: boolean): T: extends Script<T>
添加一个脚本组件
asyncGetChildByName(name: string): Promise<GameObject>
异步根据名称查找子物体
asyncReady(): Promise<GameObject>
物体准备好后返回
clone(gameObjectInfo?: GameObjectInfo): GameObject
复制对象
destroy(): void
删除对象
getBoundingBox(nonColliding?: boolean, includeFromChild?: boolean, outer?: Vector): Vector
获取物体包围盒大小
getBounds(onlyCollidingComponents: boolean, originOuter: Vector, boxExtentOuter: Vector, includeFromChild?: boolean): void
获取物体边界
getChildByGameObjectId(gameObjectId: string): GameObject
根据 gameObjectId 查找子物体
getChildByName(name: string): GameObject
根据名称查找子物体
getChildByPath(path: string): GameObject
根据路径查找子物体
getChildren(): GameObject[]
获取子物体
getChildrenByName(name: string): GameObject[]
通过名字查找所有的子物体
getComponent<T: extends Script<T>>(constructor?: (...args: unknown[]) => T: extends Script<T>): T: extends Script<T>
获取指定类型的组件
getComponentPropertys<T: extends Script<T>>(constructor: (...args: unknown[]) => T: extends Script<T>): Map<string, IPropertyOptions>
获取脚本组件属性
getComponents<T: extends Script<T>>(constructor?: (...args: unknown[]) => T: extends Script<T>): T: extends Script<T>[]
获取指定类型的所有组件
getCustomProperties(): string[]
获取自定义属性名字数组，返回对象所有自定义属性。
getCustomProperty<T: extends CustomPropertyType>(propertyName: string): T: extends CustomPropertyType
获取自定义属性的值，服务器客户端均可调用，客户端调用需注意属性同步的延迟。
getCustomPropertyChangeDelegate(property): Readonly<MulticastDelegate<(path: string, value: unknown, oldValue: unknown) => void>> client
获取给定自定义属性修改时触发的事件代理。双端对象在服务器修改自定义属性后，双端均会触发事件并执行绑定函数。
getVisibility(): boolean
获取物体是否被显示
moveBy(velocity: Vector, isLocal?: boolean): void other
按给定的速度矢量随时间平滑地移动对象
moveTo(targetPosition: Vector, time: number, isLocal?: boolean, onComplete?: () => void): void other
在指定时间内从当前位置平滑移动至目标位置
rotateBy(rotation: Quaternion Rotation, multiplier: number, isLocal?: boolean): void other
按给定的旋转量随时间平滑地旋转对象
rotateTo(targetRotation: Quaternion Rotation, time: number, isLocal?: boolean, onComplete?: () => void): void other
在指定时间内从当前旋转平滑变化至目标旋转
scaleBy(scale: Vector, isLocal?: boolean): void other
按每秒给定的缩放矢量随时间平滑缩放对象
scaleTo(targetScale: Vector, time: number, isLocal?: boolean, onComplete?: () => void): void other
在指定时间内从当前缩放平滑变化至目标缩放
setAbsolute(absolutePosition?: boolean, absoluteRotation?: boolean, absoluteScale?: boolean): void
设置物体localTransform是相对于父物体或者世界
setCustomProperty(propertyName: string, value: undefined CustomPropertyType): void server
设置自定义属性的值，双端对象需在服务器调用。当设置的属性不存在时会新增自定义属性。
setVisibility(status: boolean PropertyStatus, propagateToChildren?: boolean): void
设置物体是否被显示
stopMove(): void other
中断moveTo()、moveBy()的进一步移动
stopRotate(): void other
中断从rotateTo()或rotateBy()的进一步旋转
stopScale(): void other
中断从ScaleTo()或ScaleBy()的进一步缩放
asyncFindGameObjectById(gameObjectId: string): Promise<GameObject>
通过 gameObjectId 异步查找 GameObject
asyncGetGameObjectByPath(path: string): Promise<GameObject>
通过路径异步查找物体
asyncSpawn<T: extends GameObject<T>>(assetId: string, gameObjectInfo?: GameObjectInfo): Promise<T: extends GameObject<T>>
异步构造一个物体，创建时请尽量把信息通过 gameObjectInfo 传入以达到性能最优化。
bulkPivotTo(gameObjects: GameObject[], transforms: Transform[]): void
批量设置位置
findGameObjectById(gameObjectId: string): GameObject
通过 gameObjectId 查找物体
findGameObjectByName(name: string): GameObject
通过名字查找物体
findGameObjectsByName(name: string): GameObject[]
通过名字查找物体
findGameObjectsByTag(tag: string): GameObject[]
通过自定义标签获取物体
getGameObjectByPath(path: string): GameObject
通过路径查找物体
spawn<T: extends GameObject<T>>(assetId: string, gameObjectInfo?: GameObjectInfo): T: extends GameObject<T>
构造一个物体，创建时请尽量把信息通过 gameObjectInfo 传入以达到性能最优化。

Properties ​

Accessors ​

direction
​

• get direction(): DirectionType

• set direction(newDirectionType): void other

获取链接线的通行方向

Returns ​

DirectionType当前通行方向

设置链接线的通行方向

Parameters ​

newDirectionType DirectionType新通行方向

leftPosition
​

• get leftPosition(): Vector

• set leftPosition(newPosition): void other

获取左点位置

Returns ​

Vector当前左点位置

设置左点位置

Parameters ​

newPosition Vector新左点位置

• get navLinkArea(): LinkClassType

• set navLinkArea(newClassType): void other

获取链接区域的寻路类型

Returns ​

LinkClassType当前寻路类型

设置链接区域的寻路类型

Parameters ​

newClassType LinkClassType新寻路类型

rightPosition
​

• get rightPosition(): Vector

• set rightPosition(newPosition): void other

获取右点位置

Returns ​

Vector当前右点位置

设置右点位置

Parameters ​

newPosition Vector新右点位置

Methods ​