Reference API Roblox

Engine API

Website

Related

Reference API Roblox

PathfindingModifier

Modifiers used to represent space that has a higher or lower cost to be traversed when creating paths using the PathfindingService.

Memory categoryInstances

Member index 2

HistoryMember
509Label: string
553PassThrough: bool
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
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
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: 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
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Removed member index 1

HistoryMember
509ModifierId: string

Description

Pathfinding modifiers can be used to represent space that has a higher or lower cost to be traversed. When added as a child to a Part, it takes that Part's volume to annotate areas of the navmesh that are inside and on top of it.

You can include pathfinding modifiers in the PathfindingService:CreatePath() parameters and compute smarter paths across various materials or around defined regions.

Note that when adding a PathfindingModifier to a part, either:

  • The part is collidable and we are interested in modifying pathfinding costs of paths on top of this part, which we call area.
  • The part is non-collidable (and usually invisible in game) and we are interested in modifying pathfinding costs of paths inside the part, which we call volume.

History 6

Members 2

Label

TypeDefault
string

The name of the navigation area inside or on top of the Part volume.

For a more detailed overview of PathfindingService and PathfindingModifier, see Character Pathfinding.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 1

PassThrough

TypeDefault
boolfalse

Determines if the parts enclosed by the modifier are traversable, even if they would normally be collided with. See Character Pathfinding for details.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 2

Removed members 1

ModifierId

TypeDefault
string
Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 2

Settings