Skip to content

Api > NavMeshAgent > Warp()


NavMeshAgent.Warp(Vector3 newPosition)⚓︎

Warps agent to the provided position.

Parameters:⚓︎

Name Type Description
newPosition Vector3 New position to warp the agent to.

Returns:⚓︎

type Description
boolean True if agent is successfully warped, otherwise false.

Usage⚓︎

---@type NavMeshAgent
local navmeshagent;

---@type Vector3
local newPosition;


local val0 = navmeshagent.Warp(newPosition)

Extra Detail⚓︎

Returns true if successful, otherwise returns false.