PathfindingService On DevHub

Summary

This class is not creatable. An object of this class cannot be created with Instance.new.

This class is a service. It is a singleton that may be acquired with GetService.

This item is not replicated. Its interface does not cross the network boundary.

Memory Category	Instances

Tags: [NotCreatable, Service, NotReplicated]

Inherits (1)

Instance

Member index (5)

Type	Member	History
float	EmptyCutoff	309
Instance	ComputeRawPathAsync (Vector3 start, Vector3 finish, float maxDistance)	309
Instance	ComputeSmoothPathAsync (Vector3 start, Vector3 finish, float maxDistance)	171 309
Instance	CreatePath (Dictionary agentParameters = nil)	359
Instance	FindPathAsync (Vector3 start, Vector3 finish)	309
57 members inherited from Instance

359 Add PathfindingService.CreatePath
309 Change Tags of PathfindingService.EmptyCutoff from [NotReplicated] to [NotReplicated, Deprecated]
309 Change Tags of PathfindingService.ComputeRawPathAsync from [Yields] to [Yields, Deprecated]
309 Change Tags of PathfindingService.ComputeSmoothPathAsync from [Yields] to [Yields, Deprecated]
309 Add PathfindingService.FindPathAsync
171 Add PathfindingService.ComputeSmoothPathAsync
158 Add PathfindingService

Members

ComputeRawPathAsync On DevHub

This function yields. It will block the calling thread until completion.

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	3

Name	Type	Default
start	Vector3	none
finish	Vector3	none
maxDistance	float	none

Return Type	Instance

History

309 Change Tags of PathfindingService.ComputeRawPathAsync from [Yields] to [Yields, Deprecated]

Tags: [Yields, Deprecated]

ComputeSmoothPathAsync On DevHub

This function yields. It will block the calling thread until completion.

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	3

Name	Type	Default
start	Vector3	none
finish	Vector3	none
maxDistance	float	none

Return Type	Instance

History

309 Change Tags of PathfindingService.ComputeSmoothPathAsync from [Yields] to [Yields, Deprecated]
171 Add PathfindingService.ComputeSmoothPathAsync

Tags: [Yields, Deprecated]

CreatePath On DevHub

Parameters	1

Name	Type	Default
agentParameters	Dictionary	nil

Return Type	Instance

History

359 Add PathfindingService.CreatePath

EmptyCutoff On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	float
Category	Data
Can Load	true
Can Save	false

History

309 Change Tags of PathfindingService.EmptyCutoff from [NotReplicated] to [NotReplicated, Deprecated]

Tags: [NotReplicated, Deprecated]

FindPathAsync On DevHub

This function yields. It will block the calling thread until completion.

Parameters	2

Name	Type	Default
start	Vector3	none
finish	Vector3	none

Return Type	Instance

History

309 Add PathfindingService.FindPathAsync

Tags: [Yields]

Relevant classes (1)

Instance