Navigation: Scripting Reference Manual > Functions & Subroutines > PathEventItemID

 

PathEventItemID

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves a specific entity identifier from a specific path.

 

Syntax

n = PathEventItemID ( path, event )

 

Parameters

n (Long)

Node number of the entity  that the ray intersected in the event.

 

path As Long

The identifier of the path.

 

event As Long

The identifier of the event.  Path events can be indexed forward or backwards.  For example, an event ID of 0 indicates the first event along the path, 1 indexes the second event, etc.  When using negative event indexing, -1 indicates the last event along the path, -2 is the second to last event, etc.

 

Remarks

This function retrieves a specific entity identifier from a specific path. If there is a problem the function sets an error and returns -1.

 

See Also

Path Commands

 

Examples

RayPath Functions

 

 

 

 

 

Copyright © Photon Engineering, LLC