Skip to content

Function: isObjectAtTerminalWaypoint()

ts
function isObjectAtTerminalWaypoint(object: game_object, patrol: patrol): LuaMultiReturn<[boolean, Nillable<number>]>;

Check if object standing on terminal patrol waypoint. Verifies that object is on one of terminal waypoints.

Parameters

ParameterTypeDescription
objectgame_objectGame object to check.
patrolpatrolTarget patrol object to check.

Returns

LuaMultiReturn<[boolean, Nillable<number>]>

[whether on terminal point, terminal point index].