ArchTraverseInfo(matchArchBaseCoreObject, archTraverseContext, archTraverseSettings)

new ArchTraverseInfo(matchArchBaseCoreObject, archTraverseContext, archTraverseSettings)

The Architect Scripting class that provides traversal information when a traverse callback function is called. This class will provide access to the object that was matched in the traversal operation, contextual information about the object relative to where the traversal began in a context property and settings for the traverse in a settings property. Note: Do not attempt to create instances of this class directly. They will be created automatically as needed by Architect Scripting.

Parameters:
Name Type Description
matchArchBaseCoreObject ArchBaseCoreObject

the Architect Scripting base object that is a match.
archTraverseContext ArchTraverseContext

the Architect Scripting traversal context for the object.
archTraverseSettings ArchTraverseSettings

the Architect Scripting settings for the traversal operation.
See:

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchTraverseInfo'.

readonly context :ArchTraverseContext

Returns a traversal context object that provides information about the context of the object in relationship to the original object where the traverse call was made.

readonly isArchCallbackTraverseInfo :boolean

Returns true indicating that this is an ArchTraverseInfo instance.

readonly logStr :string

A string suitable for logging that contains information about this definition.

readonly matchObject :ArchBaseObject

Returns the Architect Scripting object for which the callback on the traverse call was made.

readonly settings :ArchTraverseSettings

Returns a traversal settings object that provides access to settings about the current traversal operation.