tweak to getTurretHeading() docs (#4456)

Baezon · web-flow · commit 0121e439aa87 · 2022-06-30T15:07:14.000-04:00
diff --git a/code/scripting/api/objs/subsystem.cpp b/code/scripting/api/objs/subsystem.cpp
@@ -665,7 +665,7 @@ ADE_FUNC(rotateTurret, l_Subsystem, "vector Pos, boolean reset=false", "Rotates
 		return ADE_RETURN_FALSE;
 }
 
-ADE_FUNC(getTurretHeading, l_Subsystem, NULL, "Returns the turrets forward vector", "vector", "Returns a normalized version of the forward vector or null vector on error")
+ADE_FUNC(getTurretHeading, l_Subsystem, NULL, "Returns the turrets forward vector", "vector", "Returns a normalized version of the forward vector in the ship's reference frame or null vector on error")
 {
 	ship_subsys_h *sso;
 	if(!ade_get_args(L, "o", l_Subsystem.GetPtr(&sso)))

Original file line number	Diff line number	Diff line change
`@@ -665,7 +665,7 @@ ADE_FUNC(rotateTurret, l_Subsystem, "vector Pos, boolean reset=false", "Rotates`
`665`	`665`	`return ADE_RETURN_FALSE;`
`666`	`666`	`}`
`667`	`667`
`668`		`-ADE_FUNC(getTurretHeading, l_Subsystem, NULL, "Returns the turrets forward vector", "vector", "Returns a normalized version of the forward vector or null vector on error")`
	`668`	`+ADE_FUNC(getTurretHeading, l_Subsystem, NULL, "Returns the turrets forward vector", "vector", "Returns a normalized version of the forward vector in the ship's reference frame or null vector on error")`
`669`	`669`	`{`
`670`	`670`	`ship_subsys_h *sso;`
`671`	`671`	`if(!ade_get_args(L, "o", l_Subsystem.GetPtr(&sso)))`