Grimes at 06:50, 2 November 2020

2020-11-02T06:50:13Z

Grimes: Created page with "{{Mission Scripting |fName= mist.getPointAtDistanceOnPath| |vNum = Mist 4.5 |desc= Returns the point and heading at a given distance along a given path. If optional roadT..."

2020-11-02T06:49:58Z

Created page with "{{Mission Scripting |fName= mist.getPointAtDistanceOnPath| |vNum = Mist 4.5 |desc= Returns the point and heading at a given distance along a given path. If optional roadT..."

New page

{{Mission Scripting

|fName= mist.getPointAtDistanceOnPath|

|vNum = Mist 4.5

|desc= Returns the point and heading at a given distance along a given path.

If optional roadType is passed and the path length is only 2 points, then the function will generate a path via land.findPathOnRoads. By default it assumes 'roads' but can be given 'railroads' value.

Optional returnFormat accepts strings of "vec2" or "vec3", by default it returns in vec2.

|rtnType= table, number

|reqType1= table

|reqName1= path

|reqType2= number

|reqName2= distance

|reqType3=

|optType1= string

|optName1= roadType

|optType2= string

|optName2= returnFormat

|optType3=

|varExamples=
{[1] = {x = 2300, y = 234526}, [2] = {x = 2300, y = -2352},[3] = {x = 35235, y = -564156},[4] = {x = 54, y = 48456456}, }

|rtnExamples=

|example=
The following example would adjust the coordinates of a group that is about to be spawned so that units are aligned on a road at a given interval.
local rPath = land.findPathOnRoads('roads', spawnPoint.x, spawnPoint.y, roadEnd.x, roadEnd.y)
for i = 2, #newGroup.units do
local newCoord, heading = getPointAtDistanceOnPath(rPath, (i-1)* 10)
newGroup.units[i].x = newCoord.x
newGroup.units[i].y = newCoord.y
newGroup.units[i].heading = heading
end

|notes=

|funcs= {{ListOfMistGeneralPurposeFuncs}}

}}
[[Category:MIST|getPathLength]]

← Older revision		Revision as of 06:50, 2 November 2020
Line 56:		Line 56:

	}}		}}
−	[[Category:MIST\|~~getPathLength~~]]	+	[[Category:MIST\|getPointAtDistanceOnPath]]

MIST getPointAtDistanceOnPath - Revision history

Grimes at 06:50, 2 November 2020

Grimes: Created page with "{{Mission Scripting |fName= mist.getPointAtDistanceOnPath| |vNum = Mist 4.5 |desc= Returns the point and heading at a given distance along a given path. If optional roadT..."