类 BaseNavMeshSurface

En

BaseNavMeshSurface is a base component used to generate navigation mesh. 2d and 3d integrate this class respectively.

Zh

BaseNavMeshSurface 是一个用于生成导航网格的基础组件，2d 和 3d 分别集成该类。

层级 (查看层级一览)

Component
- BaseNavMeshSurface
  - NavMesh2DSurface
  - NavMeshSurface

构造函数

constructor

new BaseNavMeshSurface(): BaseNavMeshSurface
实例化一个寻路功能
返回 BaseNavMeshSurface
重写了 Component.constructor
- 定义于 src/layaAir/laya/navigation/common/component/BaseNavMeshSurface.ts:171

`属性`

_extra
_extra: IComponentExtra
En
Extra data of the node.
Zh
组件的额外数据。IDE内部使用。
继承自 Component._extra
定义于 src/layaAir/laya/components/Component.ts:56

_id
_id: number
En
Unique identifier for the component.
Zh
组件的唯一标识。
继承自 Component._id
定义于 src/layaAir/laya/components/Component.ts:18

_singleton
_singleton: boolean
En
Whether the component is a singleton, meaning only one instance of this type of script can be added to the same node.
Zh
是否为单例，即同一个节点只能添加此类型的脚本一次。
继承自 Component._singleton
定义于 src/layaAir/laya/components/Component.ts:38

owner
owner: Node
En
Gets the owner Node to which the component belongs.
Zh
获取组件所属的 Node 节点。
继承自 Component.owner
定义于 src/layaAir/laya/components/Component.ts:30

runInEditor
runInEditor: boolean
En
Whether the script can run in the IDE environment.
Zh
是否可以在 IDE 环境中运行。
继承自 Component.runInEditor
定义于 src/layaAir/laya/components/Component.ts:44

scriptPath
scriptPath: string
En
The path of the script file.
Zh
脚本文件的路径。
继承自 Component.scriptPath
定义于 src/layaAir/laya/components/Component.ts:50

`访问器`

agentType
get agentType(): string
返回 string
定义于 src/layaAir/laya/navigation/common/component/BaseNavMeshSurface.ts:83
set agentType(value: string): void
参数
value: string
返回 void
En
Agent type
Zh
代理类型
定义于 src/layaAir/laya/navigation/common/component/BaseNavMeshSurface.ts:73

areaFlag
get areaFlag(): string
返回 string
定义于 src/layaAir/laya/navigation/common/component/BaseNavMeshSurface.ts:95
set areaFlag(value: string): void
参数
value: string
返回 void
En
Area type
Zh
区域类型
定义于 src/layaAir/laya/navigation/common/component/BaseNavMeshSurface.ts:91

asyn
get asyn(): boolean
返回 boolean
定义于 src/layaAir/laya/navigation/common/component/BaseNavMeshSurface.ts:106
set asyn(value: boolean): void
是否需要异步处理
参数
value: boolean
返回 void
定义于 src/layaAir/laya/navigation/common/component/BaseNavMeshSurface.ts:102

awaked
get awaked(): boolean
返回 boolean
En
whether the component has been awakened.
Zh
组件是否已经被唤醒。
继承自 Component.awaked
定义于 src/layaAir/laya/components/Component.ts:133

datas
get datas(): TextResource
返回 TextResource
定义于 src/layaAir/laya/navigation/common/component/BaseNavMeshSurface.ts:149
set datas(value: TextResource): void
参数
value: TextResource
返回 void
En
Set navigation data
Zh
设置导航数据
定义于 src/layaAir/laya/navigation/common/component/BaseNavMeshSurface.ts:144

destroyed
get destroyed(): boolean
返回 boolean
En
whether the component has been destroyed.
Zh
组件是否已经被销毁。
继承自 Component.destroyed
定义于 src/layaAir/laya/components/Component.ts:141

enabled
get enabled(): boolean
返回 boolean
En
whether the component is enabled.
Zh
是否启用组件。
继承自 Component.enabled
定义于 src/layaAir/laya/components/Component.ts:117
set enabled(value: boolean): void
参数
value: boolean
返回 void
继承自 Component.enabled
定义于 src/layaAir/laya/components/Component.ts:121

hideFlags
get hideFlags(): number
返回 number
En
The hide flags that determine the hiding behavior of the component.
Zh
确定组件隐藏行为的标志。
继承自 Component.hideFlags
定义于 src/layaAir/laya/components/Component.ts:67
set hideFlags(value: number): void
参数
value: number
返回 void
继承自 Component.hideFlags
定义于 src/layaAir/laya/components/Component.ts:71

id
get id(): number
返回 number
En
The unique identifier for the component.
Zh
组件的唯一标识。
继承自 Component.id
定义于 src/layaAir/laya/components/Component.ts:109

max
get max(): Vector3
返回 Vector3
En
The maximum bounds of the navigation mesh
Zh
导航网格的最大边界
定义于 src/layaAir/laya/navigation/common/component/BaseNavMeshSurface.ts:136

maxSimplificationError
get maxSimplificationError(): number
返回 number
定义于 src/layaAir/laya/navigation/common/component/BaseNavMeshSurface.ts:163
set maxSimplificationError(value: number): void
参数
value: number
返回 void
En
The maximum amount of simplification error for the border of the polygon.
Zh
简化多边形边框可偏移的最大量
定义于 src/layaAir/laya/navigation/common/component/BaseNavMeshSurface.ts:157

min
get min(): Vector3
返回 Vector3
En
The minimum bounds of the navigation mesh
Zh
导航网格的最小边界
定义于 src/layaAir/laya/navigation/common/component/BaseNavMeshSurface.ts:127

partitionType
get partitionType(): PartitionType
返回 PartitionType
定义于 src/layaAir/laya/navigation/common/component/BaseNavMeshSurface.ts:118
set partitionType(value: PartitionType): void
参数
value: PartitionType
返回 void
En
Set the method for generating navMesh
Zh
设置生成导航网格的方法
定义于 src/layaAir/laya/navigation/common/component/BaseNavMeshSurface.ts:114

`方法`

destroy
destroy(): void
返回 void
En
Destroy components
Zh
销毁组件
继承自 Component.destroy
定义于 src/layaAir/laya/components/Component.ts:289

findDistanceToWall
findDistanceToWall(
    pos: Vector3,
    filter: any,
): { dist: number; normal: number[]; pos: number[] }
参数
pos: Vector3The world position.
filter: anyOptional filter for the query.
返回 { dist: number; normal: number[]; pos: number[] }
An object containing the distance, position, and normal of the nearest wall, or null if not found.
En
Find the distance to the nearest wall for the specified position.
Zh
查找指定位置到最近墙壁的距离。
定义于 src/layaAir/laya/navigation/common/component/BaseNavMeshSurface.ts:272

findFllowPath
findFllowPath(
    outPaths: NavigationPathData[],
    startPos: Vector3,
    endPos: Vector3,
    speed: number,
    filter?: any,
): boolean
参数
outPaths: NavigationPathData[]The generated path.
startPos: Vector3The starting position.
endPos: Vector3The destination position.
speed: numberThe speed of the agent.
filter: any = nullOptional filter for the query.
返回 boolean
True if the path is found.
En
Find a follow path for the specified agent.
Zh
为指定代理查找跟随路径。
定义于 src/layaAir/laya/navigation/common/component/BaseNavMeshSurface.ts:257

findNearestPoly
findNearestPoly(pos: Vector3, fiter?: any, out: Vector3): number
参数
pos: Vector3World coordinates.
fiter: any = nullOptional filter for the query.
out: Vector3Used to store the position.
返回 number
Information about the nearest polygon.
En
Find the nearest polygon to the specified position.
Zh
查找指定位置最近的多边形。
定义于 src/layaAir/laya/navigation/common/component/BaseNavMeshSurface.ts:236

getPolyFlags
getPolyFlags(pos: Vector3, fiter?: any): number
参数
pos: Vector3World coordinates;
fiter: any = nullOptional query filter.
返回 number
flag
En
Get the current point's Flag
Zh
获得当前点的Flag
定义于 src/layaAir/laya/navigation/common/component/BaseNavMeshSurface.ts:219

hasHideFlag
hasHideFlag(flag: number): boolean
参数
flag: numberThe hide flag to check for.
返回 boolean
En
Checks if the component has a specific hide flag set.
Zh
检查组件是否设置了特定的隐藏标志。
继承自 Component.hasHideFlag
定义于 src/layaAir/laya/components/Component.ts:101

onAdded
onAdded(): void
返回 void
En
Called after the component is added to a node. Unlike Awake, onAdded is called even if the node is not active.
Zh
组件被添加到节点后调用，与 onAwake 不同的是，即使节点未激活也会调用 onAdded。
继承自 Component.onAdded
定义于 src/layaAir/laya/components/Component.ts:329

onAwake
onAwake(): void
返回 void
En
Executed after the component is activated. At this point, all nodes and components have been created. This method is executed only once.
Zh
组件被激活后执行，此时所有节点和组件均已创建完毕，此方法只执行一次。
继承自 Component.onAwake
定义于 src/layaAir/laya/components/Component.ts:344

onDestroy
onDestroy(): void
返回 void
En
Executed when the node is destroyed manually.
Zh
手动调用节点销毁时执行。
继承自 Component.onDestroy
定义于 src/layaAir/laya/components/Component.ts:395

onDisable
onDisable(): void
返回 void
En
Executed when the component is disabled, such as when the node is removed from the stage.
Zh
组件被禁用时执行，比如从节点从舞台移除后。
继承自 Component.onDisable
定义于 src/layaAir/laya/components/Component.ts:388

onEnable
onEnable(): void
返回 void
En
Executed after the component is enabled, such as when the node is added to the stage.
Zh
组件被启用后执行，比如节点被添加到舞台后。
继承自 Component.onEnable
定义于 src/layaAir/laya/components/Component.ts:351

可选onLateUpdate
onLateUpdate(): void
返回 void
En
Executed every frame during the late update phase, after the update phase.
Zh
每帧更新时执行，在 late update 阶段，update 阶段之后。
继承自 Component.onLateUpdate
定义于 src/layaAir/laya/components/Component.ts:370

可选onPostRender
onPostRender(): void
返回 void
En
Executed after rendering.
Zh
渲染之后执行。
继承自 Component.onPostRender
定义于 src/layaAir/laya/components/Component.ts:382

可选onPreRender
onPreRender(): void
返回 void
En
Executed before rendering.
Zh
渲染之前执行。
继承自 Component.onPreRender
定义于 src/layaAir/laya/components/Component.ts:376

可选onReset
onReset(): void
返回 void
En
Resets the component's parameters to their default values. If this function is implemented, the component will be reset and automatically recycled for future use.
If not reset, it will not be recycled for reuse.
Zh
将组件的参数重置为默认值。如果实现了这个函数，组件将被重置并自动回收到对象池，方便下次复用。
如果没有重置，则不会进行回收复用。
继承自 Component.onReset
定义于 src/layaAir/laya/components/Component.ts:338

可选onStart
onStart(): void
返回 void
En
Executed once, before the first update.
Zh
在第一次执行 update 之前执行，只会执行一次。
继承自 Component.onStart
定义于 src/layaAir/laya/components/Component.ts:358

可选onUpdate
onUpdate(): void
返回 void
En
Executed every frame during the update phase. Avoid writing complex loop logic or using the getComponent method here.
Zh
每帧更新时执行，在 update 阶段。尽量不要在这里写大循环逻辑或使用 getComponent 方法。
继承自 Component.onUpdate
定义于 src/layaAir/laya/components/Component.ts:364

类 BaseNavMeshSurface

En

Zh

层级 (查看层级一览)

索引

构造函数

属性

访问器

方法

构造函数

constructor

返回 BaseNavMeshSurface

属性

_extra

En

Zh

_id

En

Zh

_singleton

En

Zh

owner

En

Zh

runInEditor

En

Zh

scriptPath

En

Zh

访问器

agentType

返回 string

参数

返回 void

En

Zh

areaFlag

返回 string

参数

返回 void

En

Zh

asyn

返回 boolean

参数

返回 void

awaked

返回 boolean

En

Zh

datas

返回 TextResource

参数

返回 void

En

Zh

destroyed

返回 boolean

En

Zh

enabled

返回 boolean

En

Zh

参数

返回 void

hideFlags

返回 number

En

Zh

参数

返回 void

id

返回 number

En

Zh

max

返回 Vector3

`返回 BaseNavMeshSurface`

`属性`

`访问器`

`方法`

`可选`onLateUpdate