TorqueScript Reference
Path Expando

Functions

void addPathExpando (string expando, string path)
String collapsePath (string path)
String expandPath (string path)
Integer getPathExpandoCount ()
String getPathExpandoKey (int expandoIndex)
String getPathExpandoValue (int expandoIndex)
Boolean isPathExpando (string expando)
void removePathExpando (string expando)

Detailed Description

Function Documentation

◆ addPathExpando()

void addPathExpando ( string expando,
string path )

Adds the expando to the path. If it already exists then it is replaced.

◆ collapsePath()

String collapsePath ( string path)

Collapses a path into either an expando path or a relative path.

◆ expandPath()

String expandPath ( string path)

Expands an expando or relative path into a full path.

◆ getPathExpandoCount()

Integer getPathExpandoCount ( )

Gets the expando path count.

◆ getPathExpandoKey()

String getPathExpandoKey ( int expandoIndex)

Gets the path expando key (the expando name) at the specified index.

◆ getPathExpandoValue()

String getPathExpandoValue ( int expandoIndex)

Gets the path expando value (the expando path) at the specified index.

◆ isPathExpando()

Boolean isPathExpando ( string expando)

Checks whether the specified path expando is current set or not.

◆ removePathExpando()

void removePathExpando ( string expando)

Removes the specified path expando.