
© Next Limit Technologies 2010
Maxwell Render 2.5 User Manual
Chapter 17. Appendix IV. Scripting References | 140
• Function: void print( string text );
• Description: Prints the given text in the console.
• Parameters: string text: Text to print
• Returned Value: Nothing.
• Function: bool createAbsoluteFolder (string folderPath);
• Description: Creates a folder using the given absolute path.
• Parameters: string folderPath: absolute path of the folder to create.
• Returned Value: Bool: TRUE if the folder is properly created. FALSE if not.
• Function: bool createRelativeFolder (string parentFolder, string folderName);
• Description: Creates a folder with the name folderName in the given parent folder.
• Parameters:
- string parentFolder: Absolute path of the parent folder where the folder is going to
be created.
- string folderName: Name of the folder.
• Returned Value: Bool: TRUE if the folder is properly. created. FALSE if not.
• Function: string getEngineVersion( void );
• Description: Returns a string with the version of the engine used.
• Parameters: No parameters.
• Returned Value: String (engine version).
• Function: string getMaxwellFolder( void );
• Description: Returns a string with the path of the folder where Maxwell Render is
installed.
• Parameters: No parameters.
• Returned Value: String (path of the Maxwell Render folder).
• Function: string getEnv( string var );
• Description: Returns a string with the value of the given system environment
variable.
• Parameters: String var: Environment variable.
• Returned Value: String (value of the environment variable).
• Function: void ush( void );
• Description: Flushes all the pending events in the application. This function can
be useful to refresh the GUI elements that are waiting for a pending event (i.e. text
printed in console, etc.). Calling this function too often could make the application run
signicantly slower.
• Parameters: Nothing.
• Returned Value: Nothing.
• Function: string system( string var );
• Description: Calls the OS system() function.
• Parameters: String var: String given to system().
• Returned Value: Nothing.
17.02.02 File Manager
• Function: int getNumberOfFilesInFolder( string path, string lter );
• Description: Returns the number of les in the given folder that match the lter.
• Parameters: String path: Folder to search les / String lter: File lter (“*.*” is
allowed).
• Returned Value: INT: number of les in the folder that mach the lter.
• Function: stringlist getFilesInFolder( string path, string lter );
• Description: Returns a list of les in the given folder that match the lter.
• Parameters: String path: Folder to search les / String lter: File lter (“*.*” is
allowed).
• Returned Value: LIST: list of les in the folder that match the lter.
• Function: string getFileFolder( string le );
• Description: Returns the absolute path of the folder that contains the given le.
• Parameters: String le: File path
• Returned Value: String path of the folder that contains the given le.
Comentários a estes Manuais