TraceParam Interface Reference

Input&Output structure for collision tests. More...

Inheritance diagram for TraceParam:

Public Member Functions
proto external bool	IsRunning ()
Public Member Functions inherited from Managed
proto external ref Managed	Clone ()
	Return shallow copy of object, or null if it is not allowed (not public constructor)

Public Attributes
vector	Start
	Start position from where we trace.
vector	End
	End position to where we trace.
int	LayerMask = 0xffffffff
	Bitmask of layer(s) representing the traced object. The interaction matrix is used to determine whether an object can be traced.
int	TargetLayers = 0
	Bitmask of layers to trace. Not used if 0, otherwise it overrides LayerMask.
TraceFlags	Flags
IEntity	Exclude
	Use either Exclude or ExcludeArray. Never both, it has some performance penalty.
array< IEntity >	ExcludeArray
IEntity	Include
	Use either Include or IncludeArray. Never both, it has some performance penalty.
array< IEntity >	IncludeArray
	Include only these entities.
IEntity	TraceEnt
	[out] traced entity
vector	TraceNorm
	[out] traced polygon normal (X,Y,Z)
float	TraceDist
	[out] traced polygon plane distace
int	NodeIndex
	[out] bone associated with traced collider
int	ColliderIndex
	[out] trace collider index
SurfaceProperties	SurfaceProps
	[out] traced surface properties
owned string	TraceMaterial
	[out] traced surface material (usualy only on terrain)
owned string	ColliderName
	[out] traced collider name

Detailed Description

Input&Output structure for collision tests.

Member Function Documentation

IsRunning()

proto external bool TraceParam.IsRunning

(

)

Member Data Documentation

ColliderIndex

int TraceParam.ColliderIndex

[out] trace collider index

ColliderName

owned string TraceParam.ColliderName

[out] traced collider name

End

vector TraceParam.End

End position to where we trace.

Exclude

IEntity TraceParam.Exclude

Use either Exclude or ExcludeArray. Never both, it has some performance penalty.

ExcludeArray

array<IEntity> TraceParam.ExcludeArray

Flags

TraceFlags TraceParam.Flags

Include

IEntity TraceParam.Include

Use either Include or IncludeArray. Never both, it has some performance penalty.

IncludeArray

array<IEntity> TraceParam.IncludeArray

Include only these entities.

LayerMask

int TraceParam.LayerMask = 0xffffffff

Bitmask of layer(s) representing the traced object. The interaction matrix is used to determine whether an object can be traced.

NodeIndex

int TraceParam.NodeIndex

[out] bone associated with traced collider

Start

vector TraceParam.Start

Start position from where we trace.

SurfaceProps

SurfaceProperties TraceParam.SurfaceProps

[out] traced surface properties

TargetLayers

int TraceParam.TargetLayers = 0

Bitmask of layers to trace. Not used if 0, otherwise it overrides LayerMask.

TraceDist

float TraceParam.TraceDist

[out] traced polygon plane distace

TraceEnt

IEntity TraceParam.TraceEnt

[out] traced entity

TraceMaterial

owned string TraceParam.TraceMaterial

[out] traced surface material (usualy only on terrain)

TraceNorm

vector TraceParam.TraceNorm

[out] traced polygon normal (X,Y,Z)

---

The documentation for this interface was generated from the following file:

• Core/generated/World/TraceParam.c