DAZ Script | |
---|---|
ScriptFileMode | { UseExtension, TextScriptFile, DAZScriptFile, EncDAZScriptFile } |
ScriptLanguage | { Unknown, DAZScript1, DAZScript2 } |
DAZ Script | |
---|---|
void | addCode ( String code ) |
void | addLine ( String line, Number indentLevel=0 ) |
void | addLines ( String code, Number indentLevel=0 ) |
Boolean | call ( String function, Array args ) |
Boolean | checkSyntax () |
void | clear () |
Boolean | convertToDAZScript2 () |
Number | errorLine () |
String | errorMessage () |
Boolean | execute () |
Boolean | execute ( Array args ) |
DzAuthor | getAuthor () |
String | getCode () |
String | getFilename () |
Boolean | getLastStatus () |
ScriptLanguage | getScriptLanguage () |
String | getScriptType () |
DzVersion | getScriptVersion () |
Boolean | getShouldReuseInterpreter () |
Boolean | isEmpty () |
Boolean | isEncrypted () |
Boolean | loadFromFile ( String filename, Boolean convert=true ) |
void | makeEncrypted () |
Object | result () |
DzError | saveToFile ( String filename, ScriptFileMode mode=UseExtension, String filetype=“DAZ Script” ) |
void | setCode ( String code ) |
void | setReuseInterpreter ( Boolean onoff ) |
Array | stackTrace () |
Boolean | wasConverted ( DzScript::ScriptLanguage language=DzScript::DAZScript1 ) |
TODO: Add detailed description.
Save mode for saving the script to file.
—–
Script language of the file.
void : addScriptBinaryExtensionsAsMultipleFilters( DzFileFilter filter )
Parameter(s):
void : addScriptBinaryExtensionsToFilter( DzFileFilter filter )
Parameter(s):
void : addScriptOpenExtensionsAsMultipleFilters( DzFileFilter filter )
Parameter(s):
void : addScriptOpenExtensionsToFilter( DzFileFilter filter )
Parameter(s):
void : addScriptSaveExtensionsAsMultipleFilters( DzFileFilter filter )
Parameter(s):
void : addScriptSaveExtensionsToFilter( DzFileFilter filter )
Parameter(s):
void : addScriptTextExtensionsAsMultipleFilters( DzFileFilter filter, Boolean includeDeprecated=false )
Parameter(s):
void : addScriptTextExtensionsToFilter( DzFileFilter filter, Boolean includeDeprecated=false )
Parameter(s):
Object : evaluate( String code, QObject context=undefined )
This function is provided as a quick method of evaluating DAZ Script statements without needing to create a DAZ Script object.
Parameter(s):
Return Value:
Return Value:
String : getScriptFile( String filenameWithoutExtension )
Parameter(s):
Return Value:
Boolean : isScriptBinaryExtension( String ext )
Return Value:
Boolean : isScriptBinaryFile( String filename )
Return Value:
Boolean : isScriptExtension( String ext )
Return Value:
Boolean : isScriptFile( String filename )
Return Value:
Boolean : isScriptTextExtension( String ext )
Return Value:
Boolean : isScriptTextFile( String filename )
Return Value:
String : legalizeName( String str )
Takes a string that may contain special characters and returns a converted version that would be legal as a variable name in script. If the string contains no special characters, the result will be identical to the input.
Constructor.
Parameter(s):
DzScript( DzScript script )
Copy Constructor
Parameter(s):
Appends the given code to the end of the current script.
Parameter(s):
void : addLine( String line, Number indentLevel=0 )
Appends the given string and a newline character to the script.
Parameter(s):
void : addLines( String code, Number indentLevel=0 )
Appends the given code to the end of the current script.
Parameter(s):
Boolean : call( String function, Array args )
Calls a function in the script.
Parameter(s):
Return Value:
true
if the function was called successfully, false
if there was an error.Attention:
Boolean : checkSyntax()
Checks the syntax of the script for errors using the current interpreter.
Return Value:
true
if the syntax is valid, otherwise false
.void : clear()
Clears any code in the current script, and clears the encryption state if the script was read from an encrypted file.
Boolean : convertToDAZScript2()
Converts the script to DAZ Script 2 syntax.
Return Value:
String : errorMessage()
Return Value:
Execute the script.
Attention:
Return Value:
true
if the script was executed successfully, false
if there was an error.Boolean : execute( Array args )
Execute the script with an argument list.
Attention:
Parameter(s):
Return Value:
true
if the script was executed successfully, false
if there was an error.Return Value:
Return Value:
String : getFilename()
Return Value:
Boolean : getLastStatus()
Return Value:
true
if the last execution was successful, otherwise false
.ScriptLanguage : getScriptLanguage()
Return Value:
String : getScriptType()
Return Value:
DzVersion : getScriptVersion()
Return Value:
Boolean : getShouldReuseInterpreter()
Return Value:
See Also:
Return Value:
true
if the script is empty; otherwise false
.Boolean : isEncrypted()
Return Value:
true
if the contents of the script are encrypted (i.e. read from an encrypted file); otherwise false
.Attention:
Boolean : loadFromFile( String filename, Boolean convert=true )
Loads the script from a file.
Parameter(s):
Return Value:
void : makeEncrypted()
Sets the script to be encrypted.
Attention:
Return Value:
DzError : saveToFile( String filename, ScriptFileMode mode=UseExtension, String filetype=“DAZ Script” )
Save the script to a file.
Parameter(s):
Return Value:
Replaces the existing code of the script with code
.
Parameter(s):
void : setReuseInterpreter( Boolean onoff )
Sets whether the same context is used between uses of call().
Parameter(s):
true
, the same context is used between calls. If false
a new context is used for each call.Attention:
onOff
is set to true
or false
.See Also:
Array : stackTrace()
Return Value:
Boolean : wasConverted( DzScript::ScriptLanguage language=DzScript::DAZScript1 )
Access to whether or not the script was converted from the enumerated value specified.
Return Value: