PathfindingService

Missing API Documentation

This API Class does not have any or complete API documentation. Please add API documentation if possible.

PathfindingService
Not creatableThis class cannot be instantiated. ServiceThis class is a service. Not replicatedThis class is not replicated.
Icon
Added in	158 (July 2014)
Memory category	Instances
Inheritance
Object Instance PathfindingService

The PathfindingService class, added in version 158, inherits from Instance. It cannot be instantiated. It contains functions that enables Models with Humanoids to move to a certain location. It can be used with PathfindingLinks and PathfindingModifiers.

Properties

EmptyCutoff: float

• Not replicatedThis member is not replicated across the network boundary.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:PathfindingService/EmptyCutoff.

• Category: Data.
• Serialization: can load only.
• Thread safety: read safe

Methods

ComputeRawPathAsync(start: Vector3, finish: Vector3, maxDistance: float): Path

• YieldsThis function can yield the script it is used in.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
start	Vector3
finish	Vector3
maxDistance	float

• Thread safety: unsafe

ComputeSmoothPathAsync(start: Vector3, finish: Vector3, maxDistance: float): Path

• YieldsThis function can yield the script it is used in.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
start	Vector3
finish	Vector3
maxDistance	float

• Thread safety: unsafe

CreatePath(agentParameters: Dictionary = nil): Path

Parameters

Name	Type	Default
agentParameters	Dictionary	nil

• Thread safety: unsafe

FindPathAsync(start: Vector3, finish: Vector3): Path

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
start	Vector3
finish	Vector3

• Thread safety: unsafe

External links

• PathfindingService in the Roblox Creator Documentation
• PathfindingService in the Roblox API Reference