Substance 3D home
Painter Python API
API
1. API overview
2. changelog
3. plugins
4. substance_painter
  1. substance_painter overview
  2. display
  3. event
  4. exception
  5. export
  6. js
  7. logging
  8. project
  9. resource
  10. textureset
  11. ui
Tutorials

js

js module

This module allows to evaluate JavaScript code against the legacy embedded JavaScript engine. This allows to use all the exposed JavaScript API through Python scripting. The JavaScript API is described in dedicated help accessible via the Help > Scripting documentation > JavaScript API menu found in Substance 3D Painter application.

Example

import substance_painter.js 
 
# Get the common baking parameters 
js_code = 'alg.baking.commonBakingParameters()' 
common_baking_parameters = substance_painter.js.evaluate(js_code) 
 
# substance_painter.js.evaluate returns JSON, so the result is easy to retrieve and use 
apply_diffusion = common_baking_parameters['commonParameters']['Apply_Diffusion']

substance_painter.js. evaluate evaluate(js_code: str) → str

Evaluate a JavaScript expression. The JavaScript API is described in dedicated help accessible via the Help > Scripting documentation > JavaScript API menu found in Substance 3D Painter application.

Parameters: js_code (str) – The block of JavaScript code to be evaluated.
Returns: The JSON formated result of the evaluation.
Return type: str
Raises: RuntimeError – If the JavaScript exception evaluation returns an error.

Get help faster and easier

New user?

js | Substance 3D Painter Python API

js

js module

evaluate

Get help faster and easier

Ask the Community

Contact Us