CryTools for TDs

CryTools: External Apps

There are some exes in the root directory (maxscript).

scmd.exe - this is an app that will silently execute a dos command, this is no longer used, as the the latest exporter plugin now has this functionality. In the example below a directory is synced via perforce:

md5.exe- this is a freeware md5 hash generator, it is called from the CryTools md5 function.

CryTools: Global Struct

These globally available variables can be accessed through the crytools struct.

fnStore, _fnStoreIndex, _varStore, _varStoreIndex - These are global storage arrays that allow variables and functions to be stored and passed via the _storeFn, retrieveFn, storeVar, retrieveVar functions. These are never directly accessed.

localBuildNumber - returns the number of the local build. (The build that the current crytools /maxscript dir is loaded from)

BuildPathFull - returns string of the artists build path to the bin32 directory

maxDirTxt - returns string of the max root dir.

editorPath - path string to the Editor

cryINI - path string to the CryTools INI file

maxVersionNum - returns the version number of 3ds Max on which the script is being run

project_name - returns the name of the project the artist resides on, taken from the build path.

latest_build - returns the name of the latest build on S:\, this global variable is set from within UpdateTools.ms, which refreshes the latest_builds.txt stored in cry_temp. This is set to "NET_ERROR" if the location cannot be found on the network.

latestBuildNumber - returns the number of the latest build available on S:\, this global variable is set from within UpdateTools.ms, which refreshes the latest_builds.txt stored in cry_temp.

cryExportPresent - set to true or false based on whether or not the exporter plugin is loaded.

cbaPath - returns string of the CBA path.

rollback_status - returns whether or not the exporter is currently rolled back to a previous version. This is currently stored in rollback_status.ini in the cryTemp folder.

DOMAIN - returns the network domain of the network the computer is plugged into. This is set via GetDNS() once and written to the first line of cryTools.ini and then read in from there every time at load after. This var is set by AddCryTools.ms

CryTools: Functions

These functions are added on load within AddCryTools.ms, and made available through the crytools struct.

scmd <command> wait - Silently runs a dos command using the cryengine export plugin (csexport.export.execute_command_line).

md5 <filename_string> - Returns string MD5 hash for file queried, you must feed it a valid file. This function uses an open source, public domain MD5 executable stored in the /maxscript folder.

storeFn <FUNCTION> <OVERWRITE> </OVERWRITE></FUNCTION> - This stores a function in the global crytools struct where it can be used by any other script. Overwrite will overwrite any existing fn with the same name. You use retrieveFn to retrieve the var you have stored. Here is an example below from the MorphTools script:

storeVar <VAR> </VAR><ALIAS><VAR> </VAR><OVERWRITE><VAR></VAR></OVERWRITE></ALIAS> - This stores a variable in the global crytools struct where it can be used by any other script. The var is the item you are storing, and the alias is the associated name. Overwrite will overwrite a stored var with the same alias. You use retrieveVar to retrieve the var you have stored. Here is an example below from the MorphTools script:

alienBrain <command_argument_string> - This executes AlienBrain command arugments from within 3ds Max. It is set to execute the command via a JDK bridge/DOS command. This does not load ALienBrain.exe (or the long load screen associated with it) and executes the commands instantly and transparently in the background.

or something more complex like:

existFile <FILENAME_STRING></FILENAME_STRING> - Returns true/false whether file exists or not

existDir <FILENAME_STRING> </FILENAME_STRING>- Returns true/false whether directory exists or not

or something more complex like:

getDNS() - Returns the Domain Name Server of the local network. This uses a dos command to dump and read ipconfig info from a temp file that is then deleted; so it pops up a black cmd window for a milisecond when called. CryTools calls this once, and saves that info in cryTools.ini located in the cryTemp directory in the max root dir.

MirrorObjs <OBJ1> <OBJ2> <MOBJ> <MAXIS> <OAXIS> </OAXIS></MAXIS></MOBJ></OBJ2></OBJ1> - Function for mirroring joint orientations over an arbitrary axis. The below example is from CryAnimationTools.ms, you can look there to see it in use.

matchPivot <OBJ1> <OBJ2></OBJ2></OBJ1> - Aligns the pivot of an object to that of another

findRoot <OBJ></OBJ> - Returns the root of the hierarchy the object is a member of

getChildren <OBJ></OBJ> - Returns the root of the hierarchy the object is a member of

getBips - Returns the Bipeds in the current scene

getBindPoseVertexTarget <TARGETNODE> <SOURCENODE> <VERTEXID></VERTEXID></SOURCENODE></TARGETNODE>

createBindPoseMorph <TARGETNODE> <SOURCENODE> <DELETEYN> <ADDMORPHYN> <CHANNELNUM> <EXTRACTEDNODE>

</EXTRACTEDNODE></CHANNELNUM></ADDMORPHYN></DELETEYN></SOURCENODE></TARGETNODE>inFromUDP <TARGETNODE> </TARGETNODE>- This function reads the User Defined Properties for an object into an array

outToUDP <TARGETNODE> <STRING_ARRAY> <ECHO></ECHO></STRING_ARRAY></TARGETNODE> - This function reads/writes to the User Defined Properties buffer for an object

local2unc <string> - This will convert a local drive letter to a UNC path

forceLowerCase <STRING> </STRING>- This will convert a string to lowercase

nFromINI <PATH> echo</PATH> - This will read in a text file line by line and return an array where array element number corresponds to the line number.

outToINI <data> <path> echo - This will export an array to a text file line by line where array element number corresponds to the line number.

plusR <PATH></PATH> - this will check if the file exists and make it read-only

minusR <PATH></PATH> - this will check if the file exists and make it writable

objTrajectoryToSpline <OBJ> </OBJ>- this will create a spline showing the trajectory of all selected objects
cutString <STRING input> <STRING cut to> </STRING></STRING>- this removes the string to cut from the string input.

vertDistance <POS> <POS></POS></POS> - this will output the distance between two positions in space

copyPasteController <PARENTOBJ> <SELORCHILD> <COPYWHAT> </COPYWHAT></SELORCHILD></PARENTOBJ>- this will copy and paste a controller, here is an example from CryRiggingTools:

sliderMan - this is a fn that works on a selection callback, when you select a slider manipulator, it always goes into manipulate mode so that it can be used.

Items Stored in cry_temp\

A folder named cry_temp is created by AddCryTools.ms, CryTools store many things in this folder, like the following examples:

• crytools.ini - This stores user-specific options, such as window layout and control panel settings. Here are some of the things stored within:

• latest_builds.txt - When UpdateTools.ms is run, it dumps the latest builds from S:_Builds into this txt file.

• paths.txt - When CryTools were installed, the InstallCryTools.vbs created this txt file, it stores the install path of 3ds Max and Photoshop. The first line is always 3ds Max and the second Photoshop.

C:\3dsmax7\C:\graphics\Adobe Photoshop CS2\Plug-Ins\

• rollback_status.ini - A value of true/false is stored in this file. When an artist has rolled back their exporter, the file is set to true, when Get Latest Tools From AlienBrain/Latest Build is pressed in UpdateTools, rollback status is set to false because the latest exporter is installed.

• CryExport7.dlu, Morpher.dlm, MorpherMXS.dlx - When new copies of these are installed, the prior versions are saved here, where they can be rolled back to on demand. Currently, the rollback function only exists for CryExport7.dlu.