core.libraries.thirdparty.niknaks.modules.sh_pathfind_module

(no description)

Functions

AddSegment(from, to, curvature, move_type)

 View source »

Adds a segment.

Parameters

  • from Vector

  • to Vector

  • curvature number

  • move_type number

Returns

  • LPathFollowerSegment

FindClosestSeg(position)

 View source »

Returns the closest sequence.

Parameters

  • position Vector

Returns

  • LPathFollowerSegment

  • number

FindDistanceFromPath(position)

 View source »

Returns the distance from the path.

Parameters

  • position Vector

Returns

  • number

FirstSegment()

 View source »

Returns the first segment.

GetAge()

 View source »

Returns the age of the path.

GetAllSegments()

 View source »

Returns all segments.

GetClosestPosition(position)

 View source »

Returns the closest position along the path to said position.

Parameters

  • position Vector

Returns

  • Vector

GetCursorPosition()

 View source »

Returns the cursor progress along the path

Returns

  • number

GetEnd()

 View source »

Returns the ending position of the path (Note, will update if the target is an entity).

GetLength()

 View source »

Returns the length of the path.

GetPositionOnPath(distance)

 View source »

Returns the position on the path by given distance

Parameters

  • distance number

Returns

  • Vector

GetStart()

 View source »

Returns the starting position of the path.

Invalidate()

 View source »

Invalidates the path.

IsValid()

 View source »

Returns true if the path is valid.

LastSegment()

 View source »

Returns the last segment.

MoveCursor(distance)

 View source »

Moves the cursor said distance

Parameters

  • distance number

MoveCursorTo(distance)

 View source »

Moves the cursor to said distance.

Parameters

  • distance number

MoveCursorToEnd()

 View source »

Moves the cursor to the end of the path.

MoveCursorToStart()

 View source »

Moves the cursor to the start of the path.

ResetAge()

 View source »

Resets the age of the path.

findClosestSeg(position)

 View source »

Returns the closest segment and its index.

Parameters

  • position Vector

Returns

  • LPathFollowerSegment

  • number

meta.CreatePathFollower(start_pos)

 View source »

Creates an empty path-follower

Parameters

  • start_pos Vector

Returns

Tables

LPathFollower

 View source »
Incomplete

Documentation for this section is incomplete and needs expanding.

Fields

  • _segments LPathFollowerSegment[]