Script:setpath: Difference between revisions

From Arx Libertatis Wiki
Jump to navigation Jump to search
(Created page with "{{Stub}} This page describes the <code>setpath</code> script command. Usage: setpath none setpath [-wf] <name> Flags: * <code>-w</code>: Use special handling for the wor...")
 
mNo edit summary
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Stub}}
{{ScriptCommandPage
 
|description=start or stop following a path
This page describes the <code>setpath</code> script command.
|context=any
 
|special=
Usage:
none
 
|flags=
setpath none
w Turn NPCs to face the path direction - ignored for other entities
setpath [-wf] <name>
f Ignored
 
|parameters=
Flags:
path string Name of the path to follow
* <code>-w</code>: Use special handling for the worm
|intro=Paths are named sequences of timed positions with linear or smooth interpolation defined in a [[DLF_file_format|level]]. Movement along the path can be paused or reversed with the {{Command|usepath}} command.
* <code>-f</code>: Follow the path direction
}}
 
Parameters:
{| class="wikitable sortable"
! Parameter
! Type
! Description
|-
| <code><name></code>
| {{text}}
| Name of the path to follow
|}
 
The direction to move along the path can be changed using the [[Script:usepath|usepath]] script command. However calling the <code>setpath</code> command resets the direction to forwards as if <code>usepath f</code> was called right after it.
 
[[Category:Script commands]]

Latest revision as of 11:00, 17 June 2022

The setpath script command is used to start or stop following a path for an entity. Paths are named sequences of timed positions with linear or smooth interpolation defined in a level. Movement along the path can be paused or reversed with the usepath command.

Usage

setpath [-wf] <path>
setpath none

Context: Any Entity

Flags:

 -w: Turn NPCs to face the path direction - ignored for other entities
 -f: Ignored

Parameters:

ParameterTypeDescription
path string Name of the path to follow