Torque 3D - Script Manual: Packages

TorqueScript

Main   Class List   Namespace List   Online

Packages
[Console]

Functions relating to the control of packages. More...

Functions

void activatePackage (String packageName)
 Activates an existing package.
void deactivatePackage (String packageName)
 Deactivates a previously activated package.
string getFunctionPackage (string funcName)
 Provides the name of the package the function belongs to.
string getMethodPackage (string namespace, string method)
 Provides the name of the package the method belongs to.
string getPackageList ()
 Returns a space delimited list of the active packages in stack order.
bool isPackage (String identifier)
 Returns true if the identifier is the name of a declared package.

Detailed Description

Functions relating to the control of packages.

See also:
Packages

Function Documentation

void activatePackage ( String  packageName  ) 

Activates an existing package.

The activation occurs by updating the namespace linkage of existing functions and methods. If the package is already activated the function does nothing.

void deactivatePackage ( String  packageName  ) 

Deactivates a previously activated package.

The package is deactivated by removing its namespace linkages to any function or method. If there are any packages above this one in the stack they are deactivated as well. If the package is not on the stack this function does nothing.

string getFunctionPackage ( string  funcName  ) 

Provides the name of the package the function belongs to.

Parameters:
funcName String containing name of the function
Returns:
The name of the function's package
string getMethodPackage ( string  namespace,
string  method 
)

Provides the name of the package the method belongs to.

Parameters:
namespace Class or namespace, such as Player
method Name of the funciton to search for
Returns:
The name of the method's package
string getPackageList (  ) 

Returns a space delimited list of the active packages in stack order.

bool isPackage ( String  identifier  ) 

Returns true if the identifier is the name of a declared package.



Copyright © GarageGames, LLC. All Rights Reserved.