Reference API Roblox

Engine API

Website

Related

Reference API Roblox

PathfindingService

Summary

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Tags: [NotCreatable, Service, NotReplicated]

Member index 5

HistoryMember
553EmptyCutoff: float
553ComputeRawPathAsync(start: Vector3, finish: Vector3, maxDistance: float): Instance
553ComputeSmoothPathAsync(start: Vector3, finish: Vector3, maxDistance: float): Instance
462CreatePath(agentParameters: Dictionary = nil): Instance
462FindPathAsync(start: Vector3, finish: Vector3): Instance
inherited from Instance
553Archivable: bool
619Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
619Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
486GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

History 18

Members 5

ComputeRawPathAsync

Parameters (3)
startVector3
finishVector3
maxDistancefloat
Returns (1)
Instance
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. FindPathAsync should be used instead.
This function yields. It will block the calling thread until completion.

History 4

Tags: [Yields, Deprecated]

ComputeSmoothPathAsync

Parameters (3)
startVector3
finishVector3
maxDistancefloat
Returns (1)
Instance
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. FindPathAsync should be used instead.
This function yields. It will block the calling thread until completion.

History 4

Tags: [Yields, Deprecated]

CreatePath

Parameters (1)Default
agentParametersDictionarynil
Returns (1)
Instance

History 2

EmptyCutoff

TypeDefault
float0
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.
This property is not replicated. Its interface does not cross the network boundary.

History 5

Tags: [NotReplicated, Deprecated]

FindPathAsync

Parameters (2)
startVector3
finishVector3
Returns (1)
Instance
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

Settings