MAXScript Namespace Reference

Enumerations
enum class	ScriptSource : int {   NotSpecified , Embedded , NonEmbedded , Dynamic ,   DynamicAlways }

Functions
ScripterExport int	GetUIScaledValue (float value)
ScripterExport int	GetValueUIUnscaled (float value)
ScripterExport float	GetUIScaledValueFloat (float value)
ScripterExport float	GetValueUIUnscaledFloat (float value)
ScripterExport bool	SetMAXScriptListenerLogFile (const MCHAR *filename, const MCHAR *mode)
	Sets Scripting Listener log file to specified file.
ScripterExport bool	GetMAXScriptListenerLogFile (MSTR &listenerLogFileName)
	Gets the Scripting Listener log file name if present.
ScripterExport bool	CanRunScriptingFeature (MaxSDK::ISceneScriptSecurityManager::ScriptingFeature scriptingFeature)
	Test whether the specified ScriptingFeature can be executed.
ScripterExport void	ValidateCanRunMAXScriptSystemCommand (const MCHAR *command, Value **arg_list, int count)
	Validate whether MAXScript system commands can be executed.
ScripterExport void	ValidateCanRunMAXScriptSystemCommand (const MCHAR *command, const MCHAR *arguments)
	Validate whether MAXScript system commands can be executed.
ScripterExport void	ValidateCanRunPythonScripts (const MCHAR *command, Value **arg_list, int count)
	Validate whether Python scripts can be executed.
ScripterExport void	ValidateCanRunPythonScripts (const MCHAR *command, const MCHAR *arguments)
	Validate whether Python scripts can be executed.
ScripterExport MSTR	CreateStringRepresentationOfArgumentList (Value **arg_list, int count)
	Create string representation of argument list.

Enumeration Type Documentation

ScriptSource

enum class ScriptSource : int

strong

Enumerator
NotSpecified	source of the script was not specified; same security rights as for Embedded scripts will apply
Embedded	source of the script was a scene file (i.e., a scene file embedded script), security rights dependent on Safe Scene Script Execution settings
NonEmbedded	source of the script was not a scene file, full security rights, i.e. no security restrictions.
Dynamic	the script is dynamically generated at runtime and could contain input from various sources that are interpreted as scripted commands. Therefore dynamic scripts will always execute with restricted security rights, regardless of Safe Scene Script Execution settings as long as Safe Scene Script Execution is enabled
DynamicAlways	same as Dynamic, except also applies when Safe Scene Script Execution is disabled

    {
        NotSpecified,   
        Embedded,       
        NonEmbedded,    
        Dynamic,        
        DynamicAlways   
    };

Function Documentation

GetUIScaledValue()

ScripterExport int GetUIScaledValue

(

float

value

)

GetValueUIUnscaled()

ScripterExport int GetValueUIUnscaled

(

float

value

)

GetUIScaledValueFloat()

ScripterExport float GetUIScaledValueFloat

(

float

value

)

GetValueUIUnscaledFloat()

ScripterExport float GetValueUIUnscaledFloat

(

float

value

)

SetMAXScriptListenerLogFile()

ScripterExport bool SetMAXScriptListenerLogFile	(	const MCHAR *	filename,
		const MCHAR *	mode
	)

Sets Scripting Listener log file to specified file.

Parameters

[in]	filename	- The fully qualified path for the listener log file
[in]	mode	- The file open mode specification, typically "w" or "a". See the MAXScript Help file, topic FileStream Values, for a description of the mode string values. Note that this method automatically adds 't' to the specified mode string.

Returns

- true if the listener log file was created, false otherwise.

GetMAXScriptListenerLogFile()

ScripterExport bool GetMAXScriptListenerLogFile

(

MSTR &

listenerLogFileName

)

Gets the Scripting Listener log file name if present.

Parameters

[out]

listenerLogFileName

- Returns the fully qualified path for the listener log file

Returns

- true if a listener log file name was acquired, false otherwise.

CanRunScriptingFeature()

ScripterExport bool CanRunScriptingFeature

(

MaxSDK::ISceneScriptSecurityManager::ScriptingFeature

scriptingFeature

)

Test whether the specified ScriptingFeature can be executed.

This function checks to see whether the specified ScriptingFeature can be executed. The specified ScriptingFeature is disabled in the following cases:

1. When MAXScript is executing a scene file embedded script, Safe Scene Script Execution Mode is enabled in ISceneScriptSecurityManager, and the specified ScriptingFeature in embedded scripts is disabled in ISceneScriptSecurityManager.
2. When MAXScript is executing a dynamic script, which can be embedded in a scene file or not.
3. When 3ds Max is running in SecureMode.

   Parameters

   [in]

   scriptingFeature

   - The ScriptingFeature.

   Returns

   - true if commands associated with the specified ScriptingFeature can be executed, false otherwise.

   See also

   MAXScript::ScriptSource

ValidateCanRunMAXScriptSystemCommand() [1/2]

ScripterExport void ValidateCanRunMAXScriptSystemCommand	(	const MCHAR *	command,
		Value **	arg_list,
		int	count
	)

Validate whether MAXScript system commands can be executed.

This function checks to see whether MAXScript system commands can be executed, and if not throws an exception. MAXScript system command execution is disabled in the following cases:

1. When MAXScript is executing a scene file embedded script, Safe Scene Script Execution Mode is enabled in ISceneScriptSecurityManager, and MAXScript System Commands in embedded scripts is disabled in ISceneScriptSecurityManager. If this is the case, a SecurityException exception is thrown.
2. When MAXScript is executing a dynamic script, which can be embedded in a scene file or not. If this is the case, a SecurityException exception is thrown.
3. When 3ds Max is running in SecureMode. If this is the case, a RuntimeError exception is thrown. This function should be called from the code that implements the MAXScript command in question. This override of the function would be used when the code is a standard MAXScript primitive implementation. For example:

   Value* set_file_attribute_cf(Value** arg_list, int count)
   {
       check_arg_count(setFileAttribute, 3, count);
       MAXScript::ValidateCanRunMAXScriptSystemCommand(_T("setFileAttribute"), arg_list, count);
       ...

   If MAXScript system commands can not be executed, the arguments in arg_list are converted to their string representation and are appended to the command name for error reporting purposes by 3ds Max.

   Parameters

   [in]	command	- The name of the MAXScript system command. Note that this name is used only for error reporting purposes by 3ds Max.
   [in]	arg_list	- The list of arguments to the command.
   [in]	count	- The count of arguments in arg_list.

   See also

   MAXScript::ScriptSource

ValidateCanRunMAXScriptSystemCommand() [2/2]

ScripterExport void ValidateCanRunMAXScriptSystemCommand	(	const MCHAR *	command,
		const MCHAR *	arguments
	)

Validate whether MAXScript system commands can be executed.

This function checks to see whether MAXScript system commands can be executed, and if not throws an exception. MAXScript system command execution is disabled in the following cases:

1. When MAXScript is executing a scene file embedded script, Safe Scene Script Execution Mode is enabled in ISceneScriptSecurityManager, and MAXScript System Commands in embedded scripts is disabled in ISceneScriptSecurityManager. If this is the case, a SecurityException exception is thrown.
2. When MAXScript is executing a dynamic script, which can be embedded in a scene file or not. If this is the case, a SecurityException exception is thrown.
3. When 3ds Max is running in SecureMode. If this is the case, a RuntimeError exception is thrown. This function should be called from the code that implements the MAXScript command in question. This override of the function would be used when the code is not a standard MAXScript primitive implementation, and the string representation of the argument list is manually constructed. For example:

   MAXScript::ValidateCanRunMAXScriptSystemCommand(_T("executeScriptFile"), TSTR(_T("\"")) + filename +  _T("\""));

   If MAXScript system commands can not be executed, the arguments string is appended to the command name for error reporting purposes by 3ds Max.

   Parameters

   [in]	command	- The name of the MAXScript system command. Note that this name is used only for error reporting purposes by 3ds Max.
   [in]	arguments	- A string representation of the list of arguments to the command. Note that this value can be nullptr.

   See also

   MAXScript::ScriptSource

ValidateCanRunPythonScripts() [1/2]

ScripterExport void ValidateCanRunPythonScripts	(	const MCHAR *	command,
		Value **	arg_list,
		int	count
	)

Validate whether Python scripts can be executed.

This function checks to see whether Python scripts can be executed, and if not throws an exception. Python script execution through the python MAXScript interface is disabled in the following cases:

1. When the script is embedded in a scene file, Safe Scene Script Execution Mode is enabled in ISceneScriptSecurityManager, and Python script execution in embedded scripts is disabled in ISceneScriptSecurityManager. If this is the case, a SecurityException exception is thrown.
2. When MAXScript is executing a dynamic script, which can be embedded in a scene file or not. If this is the case, a SecurityException exception is thrown.
3. When 3ds Max is running in SecureMode. If this is the case, a RuntimeError exception is thrown. This function should be called from the code that attempts to run Python scripts. This override of the function would be used when the code is a standard MAXScript primitive implementation. For example:

   Value* execute_python_script_cf(Value** arg_list, int count)
   {
       check_arg_count(executePythonScript, 3, count);
       MAXScript::ValidateCanRunPythonScripts(_T("executePythonScript"), arg_list, count);
       ...

   If Python scripts can not be executed, the arguments in arg_list are converted to their string representation and are appended to the command name for error reporting purposes by 3ds Max.

   Parameters

   [in]	command	- The name of the Python script execution command. Note that this name is used only for error reporting purposes by 3ds Max.
   [in]	arg_list	- The list of arguments to the command.
   [in]	count	- The count of arguments in arg_list.

   See also

   MAXScript::ScriptSource

ValidateCanRunPythonScripts() [2/2]

ScripterExport void ValidateCanRunPythonScripts	(	const MCHAR *	command,
		const MCHAR *	arguments
	)

Validate whether Python scripts can be executed.

This function checks to see whether Python scripts can be executed, and if not throws an exception. Python script execution through the python MAXScript interface is disabled in the following cases:

1. When the script is embedded in a scene file, Safe Scene Script Execution Mode is enabled in ISceneScriptSecurityManager, and Python script execution in embedded scripts is disabled in ISceneScriptSecurityManager. If this is the case, a SecurityException exception is thrown.
2. When MAXScript is executing a dynamic script, which can be embedded in a scene file or not. If this is the case, a SecurityException exception is thrown.
3. When 3ds Max is running in SecureMode. If this is the case, a RuntimeError exception is thrown. This function should be called from the code that attempts to run Python scripts. This override of the function would be used when the code is not a standard MAXScript primitive implementation, and the string representation of the argument list is manually constructed. For example:

   MAXScript::ValidateCanRunPythonScripts(_T("executePythonScript"), TSTR(_T("\"")) + pythonScript +  _T("\""));

   If Python scripts can not be executed, the arguments string is appended to the command name for error reporting purposes by 3ds Max.

   Parameters

   [in]	command	- The name of the Python script execution command. Note that this name is used only for error reporting purposes by 3ds Max.
   [in]	arguments	- A string representation of the list of arguments to the command. Note that this value can be nullptr.

   See also

   MAXScript::ScriptSource

CreateStringRepresentationOfArgumentList()

ScripterExport MSTR CreateStringRepresentationOfArgumentList	(	Value **	arg_list,
		int	count
	)

Create string representation of argument list.

This function creates a string representation of the specified argument list. Note that this can be a fairly expensive call, and should only be called when necessary. This function would be typically be used in code that is a standard MAXScript primitive implementation. For example:

Value* dotNet_loadAssembly_cf(Value** arg_list, int count)
{
    check_arg_count_with_keys(dotNet.loadAssembly, 1, count);
    MAXScript_TLS* _tls = (MAXScript_TLS*)TlsGetValue(thread_locals_index);
    if (!MAXScript::CanRunScriptingFeature(MaxSDK::ISceneScriptSecurityManager::ScriptingFeature::DotNet))
    {
        TSTR msg = _T("dotNet.loadAssembly ");
        TSTR args = MAXScript::CreateStringRepresentationOfArgumentList(arg_list, count);
        msg.append(args);
 
        static MaxSDK::ISceneScriptSecurityManager* spISceneScriptSecurityManager =
        MaxSDK::ISceneScriptSecurityManager::GetInstance(); spISceneScriptSecurityManager->LogBlockedCommand(msg,
            MaxSDK::ISceneScriptSecurityManager::ScriptingFeature::MAXScriptSystemCommands);
        ...

Parameters

[in]	arg_list	- The list of arguments.
[in]	count	- The count of arguments in arg_list.