Skip to content

tes3aiPackageFollow⚓︎

An AI Follow package game object. Sets an actor to follow another actor at a certain distance.

This type inherits the following: tes3aiPackage

Properties⚓︎

destination⚓︎

This is the position at which the following actor will stop following their target.

Returns:


destinationCell⚓︎

The destination cell for escort and follow AI packages. For wander package, this is the cell the actor wanders in.

Returns:


distance⚓︎

Determines the size of the area the actor with this wander AI package will walk around. Measured in the in-game units.

Returns:

  • result (number)

duration⚓︎

This property represents the duration of the AI package. It is present for wander, escort and follow AI packages. Measured in the in-game hours.

Returns:

  • result (number)

followDistance⚓︎

The distance between the follower and their target in the in-game units.

Returns:

  • result (number)

hourOfDay⚓︎

Returns:

  • result (number)

isDone⚓︎

Returns:

  • result (boolean)

isFinalized⚓︎

Returns:

  • result (boolean)

isMoving⚓︎

This property is true if the parent actor is moving.

Returns:

  • result (boolean)

isReset⚓︎

Returns:

  • result (boolean)

isStarted⚓︎

Returns:

  • result (boolean)

mobile⚓︎

Access to the actor to whom this AI package belongs.

Returns:


startGameHour⚓︎

The in-game hour at which this AI package started.

Returns:

  • result (number)

targetActor⚓︎

The actor this follow AI package is set to follow.

Returns:


targetPosition⚓︎

The final position to be reached by the escort, follow, and travel AI packages.

Returns:


type⚓︎

Read-only. Maps to values in tes3.aiPackage namespace.

Returns: