Product documentation · Current desktop UI

3ds Max API

38 bundled Tech Connector wrapper functions in the current source catalog. This is not a count of the host application’s native API. A listed function may require its host application and bridge to be available.

Type to search all API references.

    ← All hosts

    Bundled Python wrappers

    1. activate
    2. animation_set_key
    3. api_call
    4. camera_names
    5. display_range
    6. entries_from_cameras
    7. entries_from_selection
    8. execute
    9. export_entry
    10. export_file_checked
    11. frames_per_second
    12. install_engine_publisher
    13. install_unreal_publisher
    14. io_export
    15. io_import
    16. material_assign
    17. material_create
    18. mesh_apply_modifier
    19. mesh_create_box
    20. publish_document
    21. read_document
    22. reload_dependencies
    23. rig_names
    24. scene_joints
    25. scene_list
    26. scene_move
    27. scene_path
    28. scene_select
    29. script_run
    30. selected_node_names
    31. selection
    32. set_display_range
    33. set_engine_context
    34. show_ui
    35. workflow_inspect_modifier_asset
    36. write_document
    37. show_sequence_manager
    38. show_sequence_manager

    activate

    api.dcc.host("3dsmax").activate(...)
    Signature
    activate(**settings)
    Target
    max_tools.Rigging.surface_spatial_skin_brush.activate
    Source
    max_tools/Rigging/surface_spatial_skin_brush.py:117
    Name status
    Friendly call available

    Parameters

    • **settings · required

    animation_set_key

    api.dcc.host("3dsmax").animation_set_key(...)
    Signature
    animation_set_key(node: str, attribute: str, frame: int, value: Any) -> dict[str, Any]
    Target
    max_tools.operations.animation_set_key
    Source
    max_tools/operations.py:122
    Name status
    Friendly call available

    Parameters

    • node · str · required
    • attribute · str · required
    • frame · int · required
    • value · Any · required

    api_call

    api.dcc.host("3dsmax").api_call(...)
    Signature
    api_call(function: str, args: list[Any] | None = None, kwargs: dict[str, Any] | None = None) -> Any
    Target
    max_tools.operations.api_call
    Source
    max_tools/operations.py:204
    Name status
    Friendly call available

    Parameters

    • function · str · required
    • args · list[Any] | None · default None
    • kwargs · dict[str, Any] | None · default None

    camera_names

    api.dcc.host("3dsmax").camera_names(...)
    Signature
    camera_names(*, runtime=None) -> list[str]
    Target
    max_tools.Cinematics.SequenceUI.sequence_utils.camera_names
    Source
    max_tools/Cinematics/SequenceUI/sequence_utils.py:58
    Name status
    Friendly call available

    Parameters

    • runtime · default None

    Related functions

    display_range

    api.dcc.host("3dsmax").display_range(...)
    Signature
    display_range(*, runtime=None) -> tuple[int, int]
    Target
    max_tools.Cinematics.SequenceUI.sequence_utils.display_range
    Source
    max_tools/Cinematics/SequenceUI/sequence_utils.py:41
    Name status
    Friendly call available

    Parameters

    • runtime · default None

    Related functions

    entries_from_cameras

    api.dcc.host("3dsmax").entries_from_cameras(...)
    Signature
    entries_from_cameras(*, runtime=None) -> list[dict[str, Any]]
    Target
    max_tools.Cinematics.SequenceUI.sequence_utils.entries_from_cameras
    Source
    max_tools/Cinematics/SequenceUI/sequence_utils.py:169
    Name status
    Friendly call available

    Parameters

    • runtime · default None

    Related functions

    entries_from_selection

    api.dcc.host("3dsmax").entries_from_selection(...)
    Signature
    entries_from_selection(*, runtime=None) -> list[dict[str, Any]]
    Target
    max_tools.Cinematics.SequenceUI.sequence_utils.entries_from_selection
    Source
    max_tools/Cinematics/SequenceUI/sequence_utils.py:152
    Name status
    Friendly call available

    Parameters

    • runtime · default None

    Related functions

    execute

    api.dcc.host("3dsmax").execute(...)
    Signature
    execute(capability: str, payload: dict[str, Any]) -> dict[str, Any]
    Target
    max_tools.Rigging.rigging_host_adapter.execute
    Source
    max_tools/Rigging/rigging_host_adapter.py:260
    Name status
    Friendly call available

    Parameters

    • capability · str · required
    • payload · dict[str, Any] · required

    export_entry

    api.dcc.host("3dsmax").export_entry(...)
    Signature
    export_entry(entry: Mapping[str, Any], *, default_directory: str = "", runtime=None) -> dict[str, Any]
    Target
    max_tools.Cinematics.SequenceUI.sequence_utils.export_entry
    Source
    max_tools/Cinematics/SequenceUI/sequence_utils.py:182
    Name status
    Friendly call available

    Parameters

    • entry · Mapping[str, Any] · required
    • default_directory · str · default ''
    • runtime · default None

    export_file_checked

    api.dcc.host("3dsmax").export_file_checked(...)
    Signature
    export_file_checked(
    Target
    max_tools.operations.export_file_checked
    Source
    max_tools/operations.py:101
    Name status
    Friendly call available

    Export with the caller's Max settings and verify the resulting file.

    Parameters

    • filepath · str · required
    • selected_only · bool · default False
    • runtime · default None
    • exporter · default None

    Related functions

    frames_per_second

    api.dcc.host("3dsmax").frames_per_second(...)
    Signature
    frames_per_second(*, runtime=None) -> float
    Target
    max_tools.Cinematics.SequenceUI.sequence_utils.frames_per_second
    Source
    max_tools/Cinematics/SequenceUI/sequence_utils.py:25
    Name status
    Friendly call available

    Parameters

    • runtime · default None

    install_engine_publisher

    api.dcc.host("3dsmax").install_engine_publisher(...)
    Signature
    install_engine_publisher(callback) -> None
    Target
    max_tools.Cinematics.SequenceUI.sequence_utils.install_engine_publisher
    Source
    max_tools/Cinematics/SequenceUI/sequence_utils.py:116
    Name status
    Friendly call available

    Install the concrete publisher supplied by a Tech Connector session.

    Parameters

    • callback · required

    Related functions

    install_unreal_publisher

    api.dcc.host("3dsmax").install_unreal_publisher(...)
    Signature
    install_unreal_publisher(
    Target
    max_tools.Cinematics.SequenceUI.sequence_utils.install_unreal_publisher
    Source
    max_tools/Cinematics/SequenceUI/sequence_utils.py:133
    Name status
    Friendly call available

    Install the concrete Tech Connector → Unreal Sequence publisher.

    Parameters

    • destination_path · default '/Game/Animations'
    • mode · default 'gameplay'
    • conflict_policy · default 'update'
    • source_control_policy · default 'auto'
    • unreal_project_path · default ''
    • unreal_command_path · default ''
    • log_file_path · default ''

    Related functions

    io_export

    api.dcc.host("3dsmax").io_export(...)
    Signature
    io_export(filepath: str, *, selected_only: bool = False) -> dict[str, Any]
    Target
    max_tools.operations.io_export
    Source
    max_tools/operations.py:117
    Name status
    Friendly call available

    Parameters

    • filepath · str · required
    • selected_only · bool · default False

    Related functions

    io_import

    api.dcc.host("3dsmax").io_import(...)
    Signature
    io_import(filepath: str) -> str
    Target
    max_tools.operations.io_import
    Source
    max_tools/operations.py:95
    Name status
    Friendly call available

    Parameters

    • filepath · str · required

    material_assign

    api.dcc.host("3dsmax").material_assign(...)
    Signature
    material_assign(material_name: str, nodes: Iterable[str]) -> list[str]
    Target
    max_tools.operations.material_assign
    Source
    max_tools/operations.py:84
    Name status
    Friendly call available

    Parameters

    • material_name · str · required
    • nodes · Iterable[str] · required

    Related functions

    material_create

    api.dcc.host("3dsmax").material_create(...)
    Signature
    material_create(material_name: str, *, color: Iterable[float] | None = None) -> str
    Target
    max_tools.operations.material_create
    Source
    max_tools/operations.py:72
    Name status
    Friendly call available

    Parameters

    • material_name · str · required
    • color · Iterable[float] | None · default None

    Related functions

    mesh_apply_modifier

    api.dcc.host("3dsmax").mesh_apply_modifier(...)
    Signature
    mesh_apply_modifier(node: str, modifier: str, parameters: dict[str, Any] | None = None) -> str
    Target
    max_tools.operations.mesh_apply_modifier
    Source
    max_tools/operations.py:59
    Name status
    Friendly call available

    Parameters

    • node · str · required
    • modifier · str · required
    • parameters · dict[str, Any] | None · default None

    Related functions

    mesh_create_box

    api.dcc.host("3dsmax").mesh_create_box(...)
    Signature
    mesh_create_box(*, name: str = "Box", size: Iterable[float] = (1.0, 1.0, 1.0)) -> str
    Target
    max_tools.operations.mesh_create_box
    Source
    max_tools/operations.py:50
    Name status
    Friendly call available

    Parameters

    • name · str · default 'Box'
    • size · Iterable[float] · default (1.0, 1.0, 1.0)

    Related functions

    publish_document

    api.dcc.host("3dsmax").publish_document(...)
    Signature
    publish_document(document: Mapping[str, Any]) -> dict[str, Any]
    Target
    max_tools.Cinematics.SequenceUI.sequence_utils.publish_document
    Source
    max_tools/Cinematics/SequenceUI/sequence_utils.py:124
    Name status
    Friendly call available

    Parameters

    • document · Mapping[str, Any] · required

    Related functions

    read_document

    api.dcc.host("3dsmax").read_document(...)
    Signature
    read_document(*, runtime=None) -> dict[str, Any]
    Target
    max_tools.Cinematics.SequenceUI.sequence_utils.read_document
    Source
    max_tools/Cinematics/SequenceUI/sequence_utils.py:76
    Name status
    Friendly call available

    Parameters

    • runtime · default None

    Related functions

    reload_dependencies

    api.dcc.host("3dsmax").reload_dependencies(...)
    Signature
    reload_dependencies() -> int
    Target
    max_tools.Rigging.rigging_host_adapter.reload_dependencies
    Source
    max_tools/Rigging/rigging_host_adapter.py:26
    Name status
    Friendly call available

    Refresh the shared portable contract used by this live Max host.

    Parameters

    None documented.

    rig_names

    api.dcc.host("3dsmax").rig_names(...)
    Signature
    rig_names(*, runtime=None) -> list[str]
    Target
    max_tools.Cinematics.SequenceUI.sequence_utils.rig_names
    Source
    max_tools/Cinematics/SequenceUI/sequence_utils.py:63
    Name status
    Friendly call available

    Parameters

    • runtime · default None

    Related functions

    scene_joints

    api.dcc.host("3dsmax").scene_joints(...)
    Signature
    scene_joints() -> dict[str, Any]
    Target
    max_tools.Rigging.rigging_host_adapter.scene_joints
    Source
    max_tools/Rigging/rigging_host_adapter.py:234
    Name status
    Friendly call available

    Parameters

    None documented.

    scene_list

    api.dcc.host("3dsmax").scene_list(...)
    Signature
    scene_list(*, selected: bool = False, limit: int = 500) -> list[str]
    Target
    max_tools.operations.scene_list
    Source
    max_tools/operations.py:22
    Name status
    Friendly call available

    Parameters

    • selected · bool · default False
    • limit · int · default 500

    Related functions

    scene_move

    api.dcc.host("3dsmax").scene_move(...)
    Signature
    scene_move(nodes: Iterable[str], translation: Iterable[float], *, relative: bool = True) -> list[str]
    Target
    max_tools.operations.scene_move
    Source
    max_tools/operations.py:38
    Name status
    Friendly call available

    Parameters

    • nodes · Iterable[str] · required
    • translation · Iterable[float] · required
    • relative · bool · default True

    Related functions

    scene_path

    api.dcc.host("3dsmax").scene_path(...)
    Signature
    scene_path(*, runtime=None) -> str
    Target
    max_tools.Cinematics.SequenceUI.sequence_utils.scene_path
    Source
    max_tools/Cinematics/SequenceUI/sequence_utils.py:29
    Name status
    Friendly call available

    Parameters

    • runtime · default None

    scene_select

    api.dcc.host("3dsmax").scene_select(...)
    Signature
    scene_select(nodes: Iterable[str], *, replace: bool = True) -> list[str]
    Target
    max_tools.operations.scene_select
    Source
    max_tools/operations.py:28
    Name status
    Friendly call available

    Parameters

    • nodes · Iterable[str] · required
    • replace · bool · default True

    Related functions

    script_run

    api.dcc.host("3dsmax").script_run(...)
    Signature
    script_run(code: str) -> Any
    Target
    max_tools.operations.script_run
    Source
    max_tools/operations.py:213
    Name status
    Friendly call available

    Parameters

    • code · str · required

    selected_node_names

    api.dcc.host("3dsmax").selected_node_names(...)
    Signature
    selected_node_names(*, runtime=None) -> list[str]
    Target
    max_tools.Cinematics.SequenceUI.sequence_utils.selected_node_names
    Source
    max_tools/Cinematics/SequenceUI/sequence_utils.py:54
    Name status
    Friendly call available

    Parameters

    • runtime · default None

    Related functions

    selection

    api.dcc.host("3dsmax").selection(...)
    Signature
    selection() -> dict[str, Any]
    Target
    max_tools.Rigging.rigging_host_adapter.selection
    Source
    max_tools/Rigging/rigging_host_adapter.py:256
    Name status
    Friendly call available

    Parameters

    None documented.

    set_display_range

    api.dcc.host("3dsmax").set_display_range(...)
    Signature
    set_display_range(start_frame: int, end_frame: int, *, runtime=None) -> None
    Target
    max_tools.Cinematics.SequenceUI.sequence_utils.set_display_range
    Source
    max_tools/Cinematics/SequenceUI/sequence_utils.py:47
    Name status
    Friendly call available

    Parameters

    • start_frame · int · required
    • end_frame · int · required
    • runtime · default None

    Related functions

    set_engine_context

    api.dcc.host("3dsmax").set_engine_context(...)
    Signature
    set_engine_context(
    Target
    max_tools.Cinematics.SequenceUI.sequence_utils.set_engine_context
    Source
    max_tools/Cinematics/SequenceUI/sequence_utils.py:103
    Name status
    Friendly call available

    Parameters

    • status · str · required
    • project · str · default ''
    • known_skeletons · default ()
    • message · str · default ''
    • runtime · default None

    Related functions

    show_ui

    api.dcc.host("3dsmax").show_ui(...)
    Signature
    show_ui()
    Target
    max_tools.Rigging.surface_spatial_skin_brush.show_ui
    Source
    max_tools/Rigging/surface_spatial_skin_brush.py:123
    Name status
    Friendly call available

    Open a native 3ds Max rollout for activating the spatial brush.

    Parameters

    None documented.

    workflow_inspect_modifier_asset

    api.dcc.host("3dsmax").workflow_inspect_modifier_asset(...)
    Signature
    workflow_inspect_modifier_asset(
    Target
    max_tools.operations.workflow_inspect_modifier_asset
    Source
    max_tools/operations.py:154
    Name status
    Friendly call available

    Parameters

    • node · str · required
    • modifier · str · required
    • material_name · str · required
    • animation_attribute · str · required
    • animation_frame · int · required
    • animation_value · Any · required
    • export_path · str · required
    • modifier_parameters · dict[str, Any] | None · default None

    Related functions

    write_document

    api.dcc.host("3dsmax").write_document(...)
    Signature
    write_document(document: Mapping[str, Any], *, runtime=None) -> dict[str, Any]
    Target
    max_tools.Cinematics.SequenceUI.sequence_utils.write_document
    Source
    max_tools/Cinematics/SequenceUI/sequence_utils.py:93
    Name status
    Friendly call available

    Parameters

    • document · Mapping[str, Any] · required
    • runtime · default None

    Related functions

    show_sequence_manager

    api.dcc.host("3dsmax").call('max_tools.Cinematics.SequenceUI.sequence_ui.show_sequence_manager', ...)
    Signature
    show_sequence_manager()
    Target
    max_tools.Cinematics.SequenceUI.sequence_ui.show_sequence_manager
    Source
    max_tools/Cinematics/SequenceUI/sequence_ui.py:522
    Name status
    Use the full target path

    Parameters

    None documented.

    show_sequence_manager

    api.dcc.host("3dsmax").call('max_tools.Cinematics.SequenceUI.sequence_utils.show_sequence_manager', ...)
    Signature
    show_sequence_manager() -> dict[str, Any]
    Target
    max_tools.Cinematics.SequenceUI.sequence_utils.show_sequence_manager
    Source
    max_tools/Cinematics/SequenceUI/sequence_utils.py:206
    Name status
    Use the full target path

    Parameters

    None documented.

    Registered host operations

    These are planner and bridge operations, not individual Python wrapper methods. Availability depends on a connected host, its bridge, required inputs, and the operation’s execution mode.

    3ds Max Set Key

    animation.set_key · host_native · changes project

    No description provided.

    Required inputs: node, attribute, frame, value.

    3ds Max API Call

    api.call · host_native · changes project

    No description provided.

    Required inputs: function.

    3ds Max Open Sequence Workspace

    cinematics.sequence_ui · host_native · read-only or UI action

    Open the 3ds Max Sequence Workspace for camera, rig, range, and FBX export authoring.

    Required inputs: none.

    3ds Max Export Scene

    io.export · host_native · read-only or UI action

    No description provided.

    Required inputs: filepath.

    3ds Max Import Scene

    io.import · host_native · changes project

    No description provided.

    Required inputs: filepath.

    3ds Max Assign Material

    material.assign · host_native · changes project

    No description provided.

    Required inputs: material_name, nodes.

    3ds Max Create Material

    material.create · host_native · changes project

    No description provided.

    Required inputs: material_name.

    3ds Max Apply Modifier

    mesh.apply_modifier · host_native · changes project

    No description provided.

    Required inputs: node, modifier.

    3ds Max Create Box

    mesh.create_box · host_native · changes project

    No description provided.

    Required inputs: none.

    3ds Max List Scene

    scene.list · host_native · read-only or UI action

    List scene nodes or the current selection through pymxs.

    Required inputs: none.

    3ds Max Move Nodes

    scene.move · host_native · changes project

    No description provided.

    Required inputs: nodes, translation.

    3ds Max Select Nodes

    scene.select · host_native · changes project

    No description provided.

    Required inputs: nodes.

    3ds Max Run Python

    script.run · host_native · changes project

    No description provided.

    Required inputs: code.

    3ds Max Inspect Modifier Asset

    workflow.inspect_modifier_asset · host_native · read-only or UI action

    Read back modifier parameters, material assignment, animation, and exported artifact.

    Required inputs: node, modifier, material_name, animation_attribute, animation_frame, animation_value, export_path.

    Screenshots show actual Tech Connector widgets with sample labels. A screenshot or saved graph does not prove a live DCC run.

    © 2026 The Entire World, LLC. Tech Connector software and original documentation. All rights reserved. Third-party names and marks belong to their respective owners. License options.