- Substance 3D home
- Painter Python API
- API
- 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 APImenu 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.
Adobe MAX
The Creativity Conference
Oct 14–16 Miami Beach and online
Adobe MAX
The Creativity Conference
Oct 14–16 Miami Beach and online