
© Next Limit Technologies 2010
Maxwell Render 2.5 User Manual
Chapter 17. Appendix IV. Scripting References | 141
• Function: string getFileName( string le );
• Description: Returns the le name of this path. The name does not include the
extension.
• Parameters: String le: File path
• Returned Value: String: name of the le.
• Function: string getFileNameAndExtension( string le );
• Description: Returns the le name of this path. The name includes the extension.
• Parameters: String le: File path
• Returned Value: String: name of the le.
• Function: INT getNumberOfFilesInBranch( string path, string lter );
• Description: Returns the number of les in the folder path and all the subfolders
that match the given lter. This function searches recursively until the branch is
completed.
• Parameters: String path: Path of the folder to search / String lter: Filter to match
• Returned Value: INT: Number of les that match the condition.
• Function: stringlist getFilesInBranch( string path, string lter );
• Description: Returns a list of les in the folder path and all its subfolders that match
the given lter. This function searches recursively until the branch is completed.
• Parameters: String path: Path of the folder to search / String lter: Filter to match
• Returned Value: LIST: List of les that match the condition.
• Function: bool copyFile( string origin, string target );
• Description: Copies a le from origin to target.
• Parameters: String origin: Path of the le to copy / String target: Path of the target
le
• Returned Value: Bool: returns True if the copy was successful, False if it was
unsuccessful.
• Function: bool removeFile( string path );
• Description: Removes the specied le.
• Parameters: String path: Path of the le to remove
• Returned Value: Bool: returns True if the le was removed successfully, False if not.
• Function: bool renameFile( string path, string name );
• Description: Renames the specied le.
• Parameters: String path: Path of the le to rename. String name: New name of the
le
• Returned Value: Bool: returns True if the le was renamed successfully, False if not.
• Function: bool createAbsoluteFolder( string path );
• Description: Creates a folder.
• Parameters: String path: Path of the folder to create
• Returned Value: Bool: returns True if the folder was created successfully, False if
not.
• Function: bool createRelativeFolder( string parentFolder, string folderName );
• Description: Creates a folder given a relative path.
• Parameters: String parentFolder: Path of the parent folder where the folder will be
created. String folderName: Name of the folder
• Returned Value: Bool: returns True if the folder was created successfully, False if
not.
17.02.03 Multilight
• Function: int getLightsCount( void );
• Description: Returns the number of lights of the current scene/ MXI loaded.
• Parameters: Nothing.
• Returned Value: INT: Number of lights.
• Function: string getLightName( int index );
• Description: Returns the name of the light (emitter material) with the given index.
• Parameters: INT index: Index of the light
• Returned Value: String: Name of the light.
• Function: void refreshLight( int index );
• Description: Refresh the light with the given index.
• Parameters: INT index: Index of the light
• Returned Value: Nothing.
Comentários a estes Manuais