LineTrace: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{Info|Function|Client|1.0}}
{{Info|Function|Client|1.0}}


{{FuncDescription|Trace a line through the specified coordinates and return the hittype entity type, identifier and the impact coordinates.}}
{{FuncDescription|Trace a line through the specified coordinates and return the [[HitType]] entity type, identifier and the impact coordinates.}}


{{FuncSyntax|LineTrace(sX, sY, sZ, eX, eY, eZ [, complex])}}
{{FuncSyntax|LineTrace(sX, sY, sZ, eX, eY, eZ [, complex])}}
Line 12: Line 12:
{{FuncParam|eY|The end Y axis}}
{{FuncParam|eY|The end Y axis}}
{{FuncParam|eZ |The end Z axis}}
{{FuncParam|eZ |The end Z axis}}
{{FuncParamOptional|complex|__EDIT_ME__}}
{{FuncParamOptional|complex|Whether to trace for complex collision, default: '''false'''.}}


{{FuncReturnValue|Hit type, Hit id, impact X, Y and Z axis.}}
{{FuncReturnValue|[[HitType|Hit entity type]], Hit entity id, impact X, Y, Z and impact normals X, Y, Z.}}


== Example ==
== Example ==
Line 22: Line 22:


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
*[[LineTrace]]
*[[createtable_ex]]
*[[GetCameraFoV]]
*[[SetCameraFoV]]
*[[Random]]
*[[RandomFloat]]
*[[Base64Encode]]
*[[Base64Decode]]
*[[GetDistance2D]]
*[[GetDistance3D]]
*[[GetDistanceSquared3D]]
*[[Lerp]]
*[[LerpVector]]
*[[VectorToRotation]]
*[[RotationToVector]]
*[[NormalizeVector]]
*[[IsFloatNearlyZero]]
*[[RandomUnitVectorInCone‎‎]]
*[[RandomUnitVectorInEllipticalCone]]
*[[UpdateStreamingLevels]]

Latest revision as of 20:35, 30 August 2020

LineTrace

Type: Function
Context: Client
Introduced: v1.0

Description

Trace a line through the specified coordinates and return the HitType entity type, identifier and the impact coordinates.

Syntax

LineTrace(sX, sY, sZ, eX, eY, eZ [, complex])

Parameters

  • sX
    The start X axis
  • sY
    The start Y axis
  • sZ
    The start Z axis
  • eX
    The end X axis
  • eY
    The end Y axis
  • eZ
    The end Z axis
  • complex (optional)
    Whether to trace for complex collision, default: false.

Return Value

Example

local hittype, hitid, impactX, impactY, impactZ = LineTrace(startX, startY, startZ, endX, endY, endZ, false)

See also